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