blob: 0dfd94def593526eaa7d5e414a85634f37509385 [file] [log] [blame]
Dave Airlie785b93e2009-08-28 15:46:53 +10001/*
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
Dave Airlie4abe3522010-03-30 05:34:18 +000033struct drm_fb_helper;
34
Jesse Barnes1a7aba72010-08-05 09:22:31 -050035#include <linux/kgdb.h>
36
Dave Airlieb0ee9e72014-10-20 16:31:53 +100037struct drm_fb_offset {
38 int x, y;
39};
40
Dave Airlie785b93e2009-08-28 15:46:53 +100041struct drm_fb_helper_crtc {
Dave Airlie785b93e2009-08-28 15:46:53 +100042 struct drm_mode_set mode_set;
Dave Airlie8be48d92010-03-30 05:34:14 +000043 struct drm_display_mode *desired_mode;
Dave Airlieb0ee9e72014-10-20 16:31:53 +100044 int x, y;
Dave Airlie785b93e2009-08-28 15:46:53 +100045};
46
Rob Clarkb7b5ee52015-03-11 10:23:08 -040047/**
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 */
Dave Airlie38651672010-03-30 05:34:13 +000066struct 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
Daniel Vetter207fd322013-01-20 22:13:14 +010075/**
76 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
Ville Syrjälä7b979362013-05-08 16:38:34 +030077 * @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
Masanari Iidae2278672014-02-18 22:54:36 +090082 * structure. Furthermore it also needs to allocate the drm
Ville Syrjälä7b979362013-05-08 16:38:34 +030083 * framebuffer used to back the fbdev.
84 * @initial_config: Setup an initial fbdev display configuration
Daniel Vetter207fd322013-01-20 22:13:14 +010085 *
86 * Driver callbacks used by the fbdev emulation helper library.
87 */
Dave Airlie4abe3522010-03-30 05:34:18 +000088struct 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);
Jesse Barnes11e17a02013-02-19 13:31:39 -080096 bool (*initial_config)(struct drm_fb_helper *fb_helper,
97 struct drm_fb_helper_crtc **crtcs,
98 struct drm_display_mode **modes,
Dave Airlieb0ee9e72014-10-20 16:31:53 +100099 struct drm_fb_offset *offsets,
Jesse Barnes11e17a02013-02-19 13:31:39 -0800100 bool *enabled, int width, int height);
Dave Airlie4abe3522010-03-30 05:34:18 +0000101};
102
Dave Airlied50ba252009-09-23 14:44:08 +1000103struct drm_fb_helper_connector {
Dave Airlie0b4c0f32010-03-30 05:34:15 +0000104 struct drm_connector *connector;
Dave Airlied50ba252009-09-23 14:44:08 +1000105};
106
Dave Airlie785b93e2009-08-28 15:46:53 +1000107struct drm_fb_helper {
108 struct drm_framebuffer *fb;
109 struct drm_device *dev;
Dave Airlie785b93e2009-08-28 15:46:53 +1000110 int crtc_count;
111 struct drm_fb_helper_crtc *crtc_info;
Dave Airlie0b4c0f32010-03-30 05:34:15 +0000112 int connector_count;
Dave Airlie65c2a892014-06-05 14:01:30 +1000113 int connector_info_alloc_count;
Dave Airlie0b4c0f32010-03-30 05:34:15 +0000114 struct drm_fb_helper_connector **connector_info;
Thierry Reding3a493872014-06-27 17:19:23 +0200115 const struct drm_fb_helper_funcs *funcs;
Dave Airlie38651672010-03-30 05:34:13 +0000116 struct fb_info *fbdev;
117 u32 pseudo_palette[17];
Dave Airlie785b93e2009-08-28 15:46:53 +1000118 struct list_head kernel_fb_list;
Dave Airlie8be48d92010-03-30 05:34:14 +0000119
Dave Airlie4abe3522010-03-30 05:34:18 +0000120 /* we got a hotplug but fbdev wasn't running the console
121 delay until next set_par */
122 bool delayed_hotplug;
Dave Airlie785b93e2009-08-28 15:46:53 +1000123};
124
Thierry Reding10a23102014-06-27 17:19:24 +0200125void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
126 const struct drm_fb_helper_funcs *funcs);
Dave Airlie4abe3522010-03-30 05:34:18 +0000127int drm_fb_helper_init(struct drm_device *dev,
128 struct drm_fb_helper *helper, int crtc_count,
Dave Airlieeb1f8e42010-05-07 06:42:51 +0000129 int max_conn);
Dave Airlie4abe3522010-03-30 05:34:18 +0000130void drm_fb_helper_fini(struct drm_fb_helper *helper);
Dave Airlie785b93e2009-08-28 15:46:53 +1000131int drm_fb_helper_blank(int blank, struct fb_info *info);
132int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
133 struct fb_info *info);
134int drm_fb_helper_set_par(struct fb_info *info);
135int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
136 struct fb_info *info);
Dave Airlie785b93e2009-08-28 15:46:53 +1000137
Rob Clark5ea1f752014-05-30 12:29:48 -0400138bool drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
Dave Airlie38651672010-03-30 05:34:13 +0000139void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
Dave Airlie785b93e2009-08-28 15:46:53 +1000140 uint32_t fb_width, uint32_t fb_height);
Dave Airlie3632ef82011-01-15 09:27:00 +1000141void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
142 uint32_t depth);
143
Dave Airlie068143d2009-10-05 09:58:02 +1000144int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
Dave Airlied50ba252009-09-23 14:44:08 +1000145
Chris Wilson73943712011-04-22 11:03:57 +0100146int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
Thierry Reding01934c22014-12-19 11:21:32 +0100147int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
Dave Airlie0b4c0f32010-03-30 05:34:15 +0000148int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
Jesse Barnes1a7aba72010-08-05 09:22:31 -0500149int drm_fb_helper_debug_enter(struct fb_info *info);
150int drm_fb_helper_debug_leave(struct fb_info *info);
Jesse Barnes2f1046f2014-02-12 12:26:24 -0800151struct drm_display_mode *
152drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
153 int width, int height);
154struct drm_display_mode *
155drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
156 int width, int height);
Dave Airlie8be48d92010-03-30 05:34:14 +0000157
Dave Airlie65c2a892014-06-05 14:01:30 +1000158int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
159int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
160 struct drm_connector *connector);
Dave Airlie785b93e2009-08-28 15:46:53 +1000161#endif