2009-08-28 09:46:53 +04:00
/*
* Copyright ( c ) 2006 - 2009 Red Hat Inc .
* Copyright ( c ) 2006 - 2008 Intel Corporation
* Copyright ( c ) 2007 Dave Airlie < airlied @ linux . ie >
*
* DRM framebuffer helper functions
*
* Permission to use , copy , modify , distribute , and sell this software and its
* documentation for any purpose is hereby granted without fee , provided that
* the above copyright notice appear in all copies and that both that copyright
* notice and this permission notice appear in supporting documentation , and
* that the name of the copyright holders not be used in advertising or
* publicity pertaining to distribution of the software without specific ,
* written prior permission . The copyright holders make no representations
* about the suitability of this software for any purpose . It is provided " as
* is " without express or implied warranty.
*
* THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE ,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS , IN NO
* EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL , INDIRECT OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE ,
* DATA OR PROFITS , WHETHER IN AN ACTION OF CONTRACT , NEGLIGENCE OR OTHER
* TORTIOUS ACTION , ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
* OF THIS SOFTWARE .
*
* Authors :
* Dave Airlie < airlied @ linux . ie >
* Jesse Barnes < jesse . barnes @ intel . com >
*/
# ifndef DRM_FB_HELPER_H
# define DRM_FB_HELPER_H
2022-11-03 18:14:38 +03:00
struct drm_clip_rect ;
2010-03-30 09:34:18 +04:00
struct drm_fb_helper ;
2022-06-30 22:51:12 +03:00
# include <linux/fb.h>
2022-11-03 18:14:34 +03:00
# include <drm/drm_client.h>
2010-08-05 18:22:31 +04:00
2015-12-04 11:45:43 +03:00
enum mode_set_atomic {
LEAVE_ATOMIC_MODE_SET ,
ENTER_ATOMIC_MODE_SET ,
} ;
2015-03-11 17:23:08 +03:00
/**
* struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
* @ fb_width : fbdev width
* @ fb_height : fbdev height
* @ surface_width : scanout buffer width
* @ surface_height : scanout buffer height
* @ surface_bpp : scanout buffer bpp
* @ surface_depth : scanout buffer depth
*
* Note that the scanout surface width / height may be larger than the fbdev
* width / height . In case of multiple displays , the scanout surface is sized
* according to the largest width / height ( so it is large enough for all CRTCs
* to scanout ) . But the fbdev width / height is sized to the minimum width /
* height of all the displays . This ensures that fbcon fits on the smallest
2019-03-27 15:58:19 +03:00
* of the attached displays . fb_width / fb_height is used by
* drm_fb_helper_fill_info ( ) to fill out the & fb_info . var structure .
2015-03-11 17:23:08 +03:00
*/
2010-03-30 09:34:13 +04:00
struct drm_fb_helper_surface_size {
u32 fb_width ;
u32 fb_height ;
u32 surface_width ;
u32 surface_height ;
u32 surface_bpp ;
u32 surface_depth ;
} ;
2013-01-21 01:13:14 +04:00
/**
* struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
*
* Driver callbacks used by the fbdev emulation helper library .
*/
2010-03-30 09:34:18 +04:00
struct drm_fb_helper_funcs {
2015-12-04 11:45:42 +03:00
/**
* @ fb_probe :
*
* Driver callback to allocate and initialize the fbdev info structure .
* Furthermore it also needs to allocate the DRM framebuffer used to
* back the fbdev .
*
* This callback is mandatory .
*
* RETURNS :
*
* The driver should return 0 on success and a negative error code on
* failure .
*/
2010-03-30 09:34:18 +04:00
int ( * fb_probe ) ( struct drm_fb_helper * helper ,
struct drm_fb_helper_surface_size * sizes ) ;
2022-11-03 18:14:38 +03:00
/**
* @ fb_dirty :
*
* Driver callback to update the framebuffer memory . If set , fbdev
* emulation will invoke this callback in regular intervals after
* the framebuffer has been written .
*
* This callback is optional .
*
* Returns :
* 0 on success , or an error code otherwise .
*/
int ( * fb_dirty ) ( struct drm_fb_helper * helper , struct drm_clip_rect * clip ) ;
2010-03-30 09:34:18 +04:00
} ;
2015-08-25 22:35:57 +03:00
/**
2015-12-04 11:45:42 +03:00
* struct drm_fb_helper - main structure to emulate fbdev on top of KMS
* @ fb : Scanout framebuffer object
* @ dev : DRM device
2015-08-25 22:35:57 +03:00
* @ funcs : driver callbacks for fb helper
2022-11-03 18:14:35 +03:00
* @ info : emulated fbdev device info struct
2015-08-25 22:35:57 +03:00
* @ pseudo_palette : fake palette of 16 colors
2020-11-20 13:25:39 +03:00
* @ damage_clip : clip rectangle used with deferred_io to accumulate damage to
* the screen buffer
* @ damage_lock : spinlock protecting @ damage_clip
* @ damage_work : worker used to flush the framebuffer
2016-08-23 14:54:06 +03:00
* @ resume_work : worker used during resume if the console lock is already taken
2015-12-04 11:45:42 +03:00
*
* This is the main structure used by the fbdev helpers . Drivers supporting
* fbdev emulation should embedded this into their overall driver structure .
2016-12-29 23:48:26 +03:00
* Drivers must also fill out a & struct drm_fb_helper_funcs with a few
2015-12-04 11:45:42 +03:00
* operations .
2015-08-25 22:35:57 +03:00
*/
2009-08-28 09:46:53 +04:00
struct drm_fb_helper {
2018-07-03 19:03:48 +03:00
/**
* @ client :
*
* DRM client used by the generic fbdev emulation .
*/
struct drm_client_dev client ;
/**
* @ buffer :
*
* Framebuffer used by the generic fbdev emulation .
*/
struct drm_client_buffer * buffer ;
2009-08-28 09:46:53 +04:00
struct drm_framebuffer * fb ;
struct drm_device * dev ;
2014-06-27 19:19:23 +04:00
const struct drm_fb_helper_funcs * funcs ;
2022-11-03 18:14:35 +03:00
struct fb_info * info ;
2010-03-30 09:34:13 +04:00
u32 pseudo_palette [ 17 ] ;
2020-11-20 13:25:39 +03:00
struct drm_clip_rect damage_clip ;
spinlock_t damage_lock ;
struct work_struct damage_work ;
2016-08-23 14:54:06 +03:00
struct work_struct resume_work ;
2015-12-04 11:45:42 +03:00
2017-07-04 18:18:23 +03:00
/**
* @ lock :
*
* Top - level FBDEV helper lock . This protects all internal data
* structures and lists , such as @ connector_info and @ crtc_info .
*
* FIXME : fbdev emulation locking is a mess and long term we want to
* protect all helper internal state with this lock as well as reduce
* core KMS locking as much as possible .
*/
struct mutex lock ;
2015-12-04 11:45:42 +03:00
/**
* @ kernel_fb_list :
*
* Entry on the global kernel_fb_helper_list , used for kgdb entry / exit .
*/
2009-08-28 09:46:53 +04:00
struct list_head kernel_fb_list ;
2010-03-30 09:34:14 +04:00
2015-12-04 11:45:42 +03:00
/**
* @ delayed_hotplug :
*
* A hotplug was received while fbdev wasn ' t in control of the DRM
* device , i . e . another KMS master was active . The output configuration
* needs to be reprobe when fbdev is in control again .
*/
2010-03-30 09:34:18 +04:00
bool delayed_hotplug ;
drm/fb-helper: Support deferred setup
FB helper code falls back to a 1024x768 mode if no outputs are connected
or don't report back any modes upon initialization. This can be annoying
because outputs that are added to FB helper later on can't be used with
FB helper if they don't support a matching mode.
The fallback is in place because VGA connectors can happen to report an
unknown connection status even when they are in fact connected.
Some drivers have custom solutions in place to defer FB helper setup
until at least one output is connected. But the logic behind these
solutions is always the same and there is nothing driver-specific about
it, so a better alterative is to fix the FB helper core and add support
for all drivers automatically.
This patch adds support for deferred FB helper setup. It checks all the
connectors for their connection status, and if all of them report to be
disconnected marks the FB helper as needing deferred setup. Whet setup
is deferred, the FB helper core will automatically retry setup after a
hotplug event, and it will keep trying until it succeeds.
v2: Rebase onto my entirely reworked fbdev helper locking. One big
difference is that this version again drops&reacquires the fbdev lock
(which is now fb_helper->lock, but before this patch series it was
mode_config->mutex), because register_framebuffer must be able to
recurse back into fbdev helper code for the initial screen setup.
v3: __drm_fb_helper_initial_config must hold fb_helper->lock upon
return, I've fumbled that in the deferred setup case (Liviu).
v4: I was blind, redo this all. __drm_fb_helper_initial_config
shouldn't need to reacquire fb_helper->lock, that just confuses
callers. I myself got confused by kernel_fb_helper_lock and somehow
thought it's the same as fb_helper->lock. Tsk.
Also simplify the logic a bit (we don't need two functions to probe
connectors), we can stick much closer to the existing code. And update
some comments I've spotted that are outdated.
v5: Don't pass -EAGAIN to drivers, it's just an internal error code
(Liviu).
v6: Add _and_unlock suffix to clarify locking (Maarten)
Cc: Liviu Dudau <liviu@dudau.co.uk>
Cc: John Stultz <john.stultz@linaro.org>
Cc: Thierry Reding <treding@nvidia.com>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Tested-by: John Stultz <john.stultz@linaro.org>
Signed-off-by: Thierry Reding <treding@nvidia.com> (v1)
Reviewed-by: Maarten Lankhorst <maarten.lankhorst@intel.com>
Reviewed-by: Liviu Dudau <liviu@dudau.co.uk>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20170706130023.28417-3-daniel.vetter@ffwll.ch
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>
2017-07-06 16:00:21 +03:00
/**
* @ deferred_setup :
*
* If no outputs are connected ( disconnected or unknown ) the FB helper
* code will defer setup until at least one of the outputs shows up .
* This field keeps track of the status so that setup can be retried
* at every hotplug event until it succeeds eventually .
*
* Protected by @ lock .
*/
bool deferred_setup ;
/**
* @ preferred_bpp :
*
* Temporary storage for the driver ' s preferred BPP setting passed to
* FB helper initialization . This needs to be tracked so that deferred
* FB helper setup can pass this on .
*
* See also : @ deferred_setup
*/
int preferred_bpp ;
2022-11-03 18:14:43 +03:00
2022-11-07 15:53:29 +03:00
/**
* @ hint_leak_smem_start :
*
* Hint to the fbdev emulation to store the framebuffer ' s physical
* address in struct & fb_info . fix . smem_start . If the hint is unset ,
* the smem_start field should always be cleared to zero .
*/
2022-11-03 18:14:43 +03:00
bool hint_leak_smem_start ;
2009-08-28 09:46:53 +04:00
} ;
2018-07-03 19:03:48 +03:00
static inline struct drm_fb_helper *
drm_fb_helper_from_client ( struct drm_client_dev * client )
{
return container_of ( client , struct drm_fb_helper , client ) ;
}
2016-09-29 23:48:37 +03:00
/**
2016-10-05 21:34:14 +03:00
* define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
2016-09-29 23:48:37 +03:00
*
* Helper define to register default implementations of drm_fb_helper
* functions . To be used in struct fb_ops of drm drivers .
*/
# define DRM_FB_HELPER_DEFAULT_OPS \
. fb_check_var = drm_fb_helper_check_var , \
. fb_set_par = drm_fb_helper_set_par , \
. fb_setcmap = drm_fb_helper_setcmap , \
. fb_blank = drm_fb_helper_blank , \
2016-11-14 02:03:12 +03:00
. fb_pan_display = drm_fb_helper_pan_display , \
. fb_debug_enter = drm_fb_helper_debug_enter , \
2017-02-28 18:36:51 +03:00
. fb_debug_leave = drm_fb_helper_debug_leave , \
. fb_ioctl = drm_fb_helper_ioctl
2016-09-29 23:48:37 +03:00
2015-08-05 09:58:57 +03:00
# ifdef CONFIG_DRM_FBDEV_EMULATION
2014-06-27 19:19:24 +04:00
void drm_fb_helper_prepare ( struct drm_device * dev , struct drm_fb_helper * helper ,
const struct drm_fb_helper_funcs * funcs ) ;
2020-03-05 15:04:28 +03:00
int drm_fb_helper_init ( struct drm_device * dev , struct drm_fb_helper * helper ) ;
2010-03-30 09:34:18 +04:00
void drm_fb_helper_fini ( struct drm_fb_helper * helper ) ;
2009-08-28 09:46:53 +04:00
int drm_fb_helper_blank ( int blank , struct fb_info * info ) ;
int drm_fb_helper_pan_display ( struct fb_var_screeninfo * var ,
struct fb_info * info ) ;
int drm_fb_helper_set_par ( struct fb_info * info ) ;
int drm_fb_helper_check_var ( struct fb_var_screeninfo * var ,
struct fb_info * info ) ;
2015-08-25 18:20:28 +03:00
int drm_fb_helper_restore_fbdev_mode_unlocked ( struct drm_fb_helper * fb_helper ) ;
2015-07-22 12:27:56 +03:00
2022-11-03 18:14:36 +03:00
struct fb_info * drm_fb_helper_alloc_info ( struct drm_fb_helper * fb_helper ) ;
2022-11-03 18:14:37 +03:00
void drm_fb_helper_unregister_info ( struct drm_fb_helper * fb_helper ) ;
2019-03-26 16:19:48 +03:00
void drm_fb_helper_fill_info ( struct fb_info * info ,
struct drm_fb_helper * fb_helper ,
struct drm_fb_helper_surface_size * sizes ) ;
2011-01-15 02:27:00 +03:00
2022-04-29 13:08:33 +03:00
void drm_fb_helper_deferred_io ( struct fb_info * info , struct list_head * pagereflist ) ;
2016-04-28 18:18:33 +03:00
2015-07-31 13:51:41 +03:00
ssize_t drm_fb_helper_sys_read ( struct fb_info * info , char __user * buf ,
size_t count , loff_t * ppos ) ;
ssize_t drm_fb_helper_sys_write ( struct fb_info * info , const char __user * buf ,
size_t count , loff_t * ppos ) ;
2015-07-31 13:51:42 +03:00
void drm_fb_helper_sys_fillrect ( struct fb_info * info ,
const struct fb_fillrect * rect ) ;
void drm_fb_helper_sys_copyarea ( struct fb_info * info ,
const struct fb_copyarea * area ) ;
void drm_fb_helper_sys_imageblit ( struct fb_info * info ,
const struct fb_image * image ) ;
2022-11-03 18:14:40 +03:00
ssize_t drm_fb_helper_cfb_read ( struct fb_info * info , char __user * buf ,
size_t count , loff_t * ppos ) ;
ssize_t drm_fb_helper_cfb_write ( struct fb_info * info , const char __user * buf ,
size_t count , loff_t * ppos ) ;
2015-07-31 13:51:42 +03:00
void drm_fb_helper_cfb_fillrect ( struct fb_info * info ,
const struct fb_fillrect * rect ) ;
void drm_fb_helper_cfb_copyarea ( struct fb_info * info ,
const struct fb_copyarea * area ) ;
void drm_fb_helper_cfb_imageblit ( struct fb_info * info ,
const struct fb_image * image ) ;
2016-08-23 18:27:27 +03:00
void drm_fb_helper_set_suspend ( struct drm_fb_helper * fb_helper , bool suspend ) ;
2016-08-23 14:54:06 +03:00
void drm_fb_helper_set_suspend_unlocked ( struct drm_fb_helper * fb_helper ,
2016-08-23 18:27:27 +03:00
bool suspend ) ;
2015-07-31 13:51:43 +03:00
2009-10-05 03:58:02 +04:00
int drm_fb_helper_setcmap ( struct fb_cmap * cmap , struct fb_info * info ) ;
drm/kms: start adding command line interface using fb.
[note this requires an fb patch posted to linux-fbdev-devel already]
This uses the normal video= command line option to control the kms
output setup at boot time. It is used to override the autodetection
done by kms.
video= normally takes a framebuffer as the first parameter, in kms
it will take a connector name, DVI-I-1, or LVDS-1 etc. If no output
connector is specified the mode string will apply to all connectors.
The mode specification used will match down the probed modes, and if
no mode is found it will add a CVT mode that matches.
video=1024x768 - all connectors match a 1024x768 mode or add a CVT on
video=VGA-1:1024x768, VGA-1 connector gets mode only.
The same strings as used in current fb modedb.c are used, except I've
added three more letters, e, D, d, e = enable, D = enable Digital,
d = disable, which allow a connector to be forced into a certain state.
Signed-off-by: Dave Airlie <airlied@redhat.com>
2009-09-23 08:44:08 +04:00
2017-02-28 18:36:51 +03:00
int drm_fb_helper_ioctl ( struct fb_info * info , unsigned int cmd ,
unsigned long arg ) ;
2011-04-22 14:03:57 +04:00
int drm_fb_helper_hotplug_event ( struct drm_fb_helper * fb_helper ) ;
2014-12-19 13:21:32 +03:00
int drm_fb_helper_initial_config ( struct drm_fb_helper * fb_helper , int bpp_sel ) ;
2010-08-05 18:22:31 +04:00
int drm_fb_helper_debug_enter ( struct fb_info * info ) ;
int drm_fb_helper_debug_leave ( struct fb_info * info ) ;
2017-10-30 18:39:39 +03:00
void drm_fb_helper_lastclose ( struct drm_device * dev ) ;
void drm_fb_helper_output_poll_changed ( struct drm_device * dev ) ;
2015-08-05 09:58:57 +03:00
# else
static inline void drm_fb_helper_prepare ( struct drm_device * dev ,
struct drm_fb_helper * helper ,
const struct drm_fb_helper_funcs * funcs )
{
}
static inline int drm_fb_helper_init ( struct drm_device * dev ,
2020-03-05 15:04:28 +03:00
struct drm_fb_helper * helper )
2015-08-05 09:58:57 +03:00
{
2017-12-15 20:51:13 +03:00
/* So drivers can use it to free the struct */
helper - > dev = dev ;
dev - > fb_helper = helper ;
2015-08-05 09:58:57 +03:00
return 0 ;
}
static inline void drm_fb_helper_fini ( struct drm_fb_helper * helper )
{
2017-12-15 20:51:13 +03:00
if ( helper & & helper - > dev )
helper - > dev - > fb_helper = NULL ;
2015-08-05 09:58:57 +03:00
}
static inline int drm_fb_helper_blank ( int blank , struct fb_info * info )
{
return 0 ;
}
static inline int drm_fb_helper_pan_display ( struct fb_var_screeninfo * var ,
struct fb_info * info )
{
return 0 ;
}
static inline int drm_fb_helper_set_par ( struct fb_info * info )
{
return 0 ;
}
static inline int drm_fb_helper_check_var ( struct fb_var_screeninfo * var ,
struct fb_info * info )
{
return 0 ;
}
2015-08-25 18:20:28 +03:00
static inline int
2015-08-05 09:58:57 +03:00
drm_fb_helper_restore_fbdev_mode_unlocked ( struct drm_fb_helper * fb_helper )
{
2015-08-25 18:20:28 +03:00
return 0 ;
2015-08-05 09:58:57 +03:00
}
static inline struct fb_info *
2022-11-03 18:14:36 +03:00
drm_fb_helper_alloc_info ( struct drm_fb_helper * fb_helper )
2015-08-05 09:58:57 +03:00
{
return NULL ;
}
2022-11-03 18:14:37 +03:00
static inline void drm_fb_helper_unregister_info ( struct drm_fb_helper * fb_helper )
2015-08-05 09:58:57 +03:00
{
}
2019-03-27 15:58:19 +03:00
static inline void
drm_fb_helper_fill_info ( struct fb_info * info ,
struct drm_fb_helper * fb_helper ,
struct drm_fb_helper_surface_size * sizes )
2015-08-05 09:58:57 +03:00
{
}
static inline int drm_fb_helper_setcmap ( struct fb_cmap * cmap ,
struct fb_info * info )
{
return 0 ;
}
2017-02-28 18:36:51 +03:00
static inline int drm_fb_helper_ioctl ( struct fb_info * info , unsigned int cmd ,
unsigned long arg )
{
return 0 ;
}
2016-04-28 18:18:33 +03:00
static inline void drm_fb_helper_deferred_io ( struct fb_info * info ,
struct list_head * pagelist )
{
}
2017-12-15 20:51:17 +03:00
static inline int drm_fb_helper_defio_init ( struct drm_fb_helper * fb_helper )
{
return - ENODEV ;
}
2015-08-05 09:58:57 +03:00
static inline ssize_t drm_fb_helper_sys_read ( struct fb_info * info ,
char __user * buf , size_t count ,
loff_t * ppos )
{
return - ENODEV ;
}
static inline ssize_t drm_fb_helper_sys_write ( struct fb_info * info ,
const char __user * buf ,
size_t count , loff_t * ppos )
{
return - ENODEV ;
}
static inline void drm_fb_helper_sys_fillrect ( struct fb_info * info ,
const struct fb_fillrect * rect )
{
}
static inline void drm_fb_helper_sys_copyarea ( struct fb_info * info ,
const struct fb_copyarea * area )
{
}
static inline void drm_fb_helper_sys_imageblit ( struct fb_info * info ,
const struct fb_image * image )
{
}
2022-11-03 18:14:40 +03:00
static inline ssize_t drm_fb_helper_cfb_read ( struct fb_info * info , char __user * buf ,
size_t count , loff_t * ppos )
{
return - ENODEV ;
}
static inline ssize_t drm_fb_helper_cfb_write ( struct fb_info * info , const char __user * buf ,
size_t count , loff_t * ppos )
{
return - ENODEV ;
}
2015-08-05 09:58:57 +03:00
static inline void drm_fb_helper_cfb_fillrect ( struct fb_info * info ,
const struct fb_fillrect * rect )
{
}
static inline void drm_fb_helper_cfb_copyarea ( struct fb_info * info ,
const struct fb_copyarea * area )
{
}
static inline void drm_fb_helper_cfb_imageblit ( struct fb_info * info ,
const struct fb_image * image )
{
}
static inline void drm_fb_helper_set_suspend ( struct drm_fb_helper * fb_helper ,
2016-08-23 18:27:27 +03:00
bool suspend )
2015-08-05 09:58:57 +03:00
{
}
2016-08-23 14:54:06 +03:00
static inline void
2016-08-23 18:27:27 +03:00
drm_fb_helper_set_suspend_unlocked ( struct drm_fb_helper * fb_helper , bool suspend )
2016-08-23 14:54:06 +03:00
{
}
2015-08-05 09:58:57 +03:00
static inline int drm_fb_helper_hotplug_event ( struct drm_fb_helper * fb_helper )
{
return 0 ;
}
static inline int drm_fb_helper_initial_config ( struct drm_fb_helper * fb_helper ,
int bpp_sel )
{
return 0 ;
}
static inline int drm_fb_helper_debug_enter ( struct fb_info * info )
{
return 0 ;
}
static inline int drm_fb_helper_debug_leave ( struct fb_info * info )
{
return 0 ;
}
2017-10-30 18:39:39 +03:00
static inline void drm_fb_helper_lastclose ( struct drm_device * dev )
{
}
static inline void drm_fb_helper_output_poll_changed ( struct drm_device * dev )
{
}
2016-08-22 23:44:52 +03:00
# endif
2009-08-28 09:46:53 +04:00
# endif