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