include/drm/drm_fb_helper.h

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