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 /** 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 60 * of the attached displays. 61 * 62 * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height, 63 * rather than the surface size. 64 */ 65 struct drm_fb_helper_surface_size { 66 u32 fb_width; 67 u32 fb_height; 68 u32 surface_width; 69 u32 surface_height; 70 u32 surface_bpp; 71 u32 surface_depth; 72 }; 73 74 /** 75 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library 76 * @gamma_set: Set the given gamma lut register on the given crtc. 77 * @gamma_get: Read the given gamma lut register on the given crtc, used to 78 * save the current lut when force-restoring the fbdev for e.g. 79 * kdbg. 80 * @fb_probe: Driver callback to allocate and initialize the fbdev info 81 * structure. Furthermore it also needs to allocate the drm 82 * framebuffer used to back the fbdev. 83 * @initial_config: Setup an initial fbdev display configuration 84 * 85 * Driver callbacks used by the fbdev emulation helper library. 86 */ 87 struct drm_fb_helper_funcs { 88 void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green, 89 u16 blue, int regno); 90 void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green, 91 u16 *blue, int regno); 92 93 int (*fb_probe)(struct drm_fb_helper *helper, 94 struct drm_fb_helper_surface_size *sizes); 95 bool (*initial_config)(struct drm_fb_helper *fb_helper, 96 struct drm_fb_helper_crtc **crtcs, 97 struct drm_display_mode **modes, 98 struct drm_fb_offset *offsets, 99 bool *enabled, int width, int height); 100 }; 101 102 struct drm_fb_helper_connector { 103 struct drm_connector *connector; 104 }; 105 106 /** 107 * struct drm_fb_helper - helper to emulate fbdev on top of kms 108 * @fb: Scanout framebuffer object 109 * @dev: DRM device 110 * @crtc_count: number of possible CRTCs 111 * @crtc_info: per-CRTC helper state (mode, x/y offset, etc) 112 * @connector_count: number of connected connectors 113 * @connector_info_alloc_count: size of connector_info 114 * @funcs: driver callbacks for fb helper 115 * @fbdev: emulated fbdev device info struct 116 * @pseudo_palette: fake palette of 16 colors 117 * @kernel_fb_list: list_head in kernel_fb_helper_list 118 * @delayed_hotplug: was there a hotplug while kms master active? 119 */ 120 struct drm_fb_helper { 121 struct drm_framebuffer *fb; 122 struct drm_device *dev; 123 int crtc_count; 124 struct drm_fb_helper_crtc *crtc_info; 125 int connector_count; 126 int connector_info_alloc_count; 127 struct drm_fb_helper_connector **connector_info; 128 const struct drm_fb_helper_funcs *funcs; 129 struct fb_info *fbdev; 130 u32 pseudo_palette[17]; 131 struct list_head kernel_fb_list; 132 133 /* we got a hotplug but fbdev wasn't running the console 134 delay until next set_par */ 135 bool delayed_hotplug; 136 137 /** 138 * @atomic: 139 * 140 * Use atomic updates for restore_fbdev_mode(), etc. This defaults to 141 * true if driver has DRIVER_ATOMIC feature flag, but drivers can 142 * override it to true after drm_fb_helper_init() if they support atomic 143 * modeset but do not yet advertise DRIVER_ATOMIC (note that fb-helper 144 * does not require ASYNC commits). 145 */ 146 bool atomic; 147 148 #ifdef __DragonFly__ 149 struct task fb_mode_task; 150 #endif 151 }; 152 153 #define CONFIG_DRM_FBDEV_EMULATION 1 154 #ifdef CONFIG_DRM_FBDEV_EMULATION 155 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper, 156 const struct drm_fb_helper_funcs *funcs); 157 int drm_fb_helper_init(struct drm_device *dev, 158 struct drm_fb_helper *helper, int crtc_count, 159 int max_conn); 160 void drm_fb_helper_fini(struct drm_fb_helper *helper); 161 int drm_fb_helper_blank(int blank, struct fb_info *info); 162 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, 163 struct fb_info *info); 164 int drm_fb_helper_set_par(struct fb_info *info); 165 int drm_fb_helper_check_var(struct fb_var_screeninfo *var, 166 struct fb_info *info); 167 168 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper); 169 170 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper); 171 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper); 172 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper); 173 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper, 174 uint32_t fb_width, uint32_t fb_height); 175 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, 176 uint32_t depth); 177 178 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper); 179 180 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf, 181 size_t count, loff_t *ppos); 182 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf, 183 size_t count, loff_t *ppos); 184 185 void drm_fb_helper_sys_fillrect(struct fb_info *info, 186 const struct fb_fillrect *rect); 187 void drm_fb_helper_sys_copyarea(struct fb_info *info, 188 const struct fb_copyarea *area); 189 void drm_fb_helper_sys_imageblit(struct fb_info *info, 190 const struct fb_image *image); 191 192 void drm_fb_helper_cfb_fillrect(struct fb_info *info, 193 const struct fb_fillrect *rect); 194 void drm_fb_helper_cfb_copyarea(struct fb_info *info, 195 const struct fb_copyarea *area); 196 void drm_fb_helper_cfb_imageblit(struct fb_info *info, 197 const struct fb_image *image); 198 199 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, int state); 200 201 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info); 202 203 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper); 204 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel); 205 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper); 206 int drm_fb_helper_debug_enter(struct fb_info *info); 207 int drm_fb_helper_debug_leave(struct fb_info *info); 208 struct drm_display_mode * 209 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, 210 int width, int height); 211 struct drm_display_mode * 212 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, 213 int width, int height); 214 215 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector); 216 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, 217 struct drm_connector *connector); 218 #else 219 static inline void drm_fb_helper_prepare(struct drm_device *dev, 220 struct drm_fb_helper *helper, 221 const struct drm_fb_helper_funcs *funcs) 222 { 223 } 224 225 static inline int drm_fb_helper_init(struct drm_device *dev, 226 struct drm_fb_helper *helper, int crtc_count, 227 int max_conn) 228 { 229 return 0; 230 } 231 232 static inline void drm_fb_helper_fini(struct drm_fb_helper *helper) 233 { 234 } 235 236 static inline int drm_fb_helper_blank(int blank, struct fb_info *info) 237 { 238 return 0; 239 } 240 241 static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var, 242 struct fb_info *info) 243 { 244 return 0; 245 } 246 247 static inline int drm_fb_helper_set_par(struct fb_info *info) 248 { 249 return 0; 250 } 251 252 static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var, 253 struct fb_info *info) 254 { 255 return 0; 256 } 257 258 static inline int 259 drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper) 260 { 261 return 0; 262 } 263 264 static inline struct fb_info * 265 drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper) 266 { 267 return NULL; 268 } 269 270 static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper) 271 { 272 } 273 static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper) 274 { 275 } 276 277 static inline void drm_fb_helper_fill_var(struct fb_info *info, 278 struct drm_fb_helper *fb_helper, 279 uint32_t fb_width, uint32_t fb_height) 280 { 281 } 282 283 static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch, 284 uint32_t depth) 285 { 286 } 287 288 static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap, 289 struct fb_info *info) 290 { 291 return 0; 292 } 293 294 static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper) 295 { 296 } 297 298 static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info, 299 char __user *buf, size_t count, 300 loff_t *ppos) 301 { 302 return -ENODEV; 303 } 304 305 static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info, 306 const char __user *buf, 307 size_t count, loff_t *ppos) 308 { 309 return -ENODEV; 310 } 311 312 static inline void drm_fb_helper_sys_fillrect(struct fb_info *info, 313 const struct fb_fillrect *rect) 314 { 315 } 316 317 static inline void drm_fb_helper_sys_copyarea(struct fb_info *info, 318 const struct fb_copyarea *area) 319 { 320 } 321 322 static inline void drm_fb_helper_sys_imageblit(struct fb_info *info, 323 const struct fb_image *image) 324 { 325 } 326 327 static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info, 328 const struct fb_fillrect *rect) 329 { 330 } 331 332 static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info, 333 const struct fb_copyarea *area) 334 { 335 } 336 337 static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info, 338 const struct fb_image *image) 339 { 340 } 341 342 static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, 343 int state) 344 { 345 } 346 347 static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper) 348 { 349 return 0; 350 } 351 352 static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, 353 int bpp_sel) 354 { 355 return 0; 356 } 357 358 static inline int 359 drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper) 360 { 361 return 0; 362 } 363 364 static inline int drm_fb_helper_debug_enter(struct fb_info *info) 365 { 366 return 0; 367 } 368 369 static inline int drm_fb_helper_debug_leave(struct fb_info *info) 370 { 371 return 0; 372 } 373 374 static inline struct drm_display_mode * 375 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, 376 int width, int height) 377 { 378 return NULL; 379 } 380 381 static inline struct drm_display_mode * 382 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn, 383 int width, int height) 384 { 385 return NULL; 386 } 387 388 static inline int 389 drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, 390 struct drm_connector *connector) 391 { 392 return 0; 393 } 394 395 static inline int 396 drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper, 397 struct drm_connector *connector) 398 { 399 return 0; 400 } 401 #endif 402 #endif 403