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