drm_fb_helper.h

Go to the documentation of this file.

/*
 * 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
 
struct drm_clip_rect;
struct drm_fb_helper;
 
#include <linux/fb.h>
 
#include <drm/drm_client.h>
 
struct drm_fb_helper_surface_size {
    u32 fb_width;
    u32 fb_height;
    u32 surface_width;
    u32 surface_height;
    u32 surface_bpp;
    u32 surface_depth;
};
 
struct drm_fb_helper_funcs {
    int (*fb_dirty)(struct drm_fb_helper *helper, struct drm_clip_rect *clip);
 
    void (*fb_restore)(struct drm_fb_helper *helper);
 
    void (*fb_set_suspend)(struct drm_fb_helper *helper, bool suspend);
};
 
struct drm_fb_helper {
    struct drm_client_dev client;
 
    struct drm_client_buffer *buffer;
 
    struct drm_framebuffer *fb;
    struct drm_device *dev;
    const struct drm_fb_helper_funcs *funcs;
    struct fb_info *info;
    u32 pseudo_palette[17];
    struct drm_clip_rect damage_clip;
    spinlock_t damage_lock;
    struct work_struct damage_work;
    struct work_struct resume_work;
 
    struct mutex lock;
 
    bool delayed_hotplug;
 
    bool deferred_setup;
 
    int preferred_bpp;
 
#ifdef CONFIG_FB_DEFERRED_IO
    struct fb_deferred_io fbdefio;
#endif
};
 
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);
}
 
#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, \
    .fb_pan_display = drm_fb_helper_pan_display, \
    .fb_ioctl   = drm_fb_helper_ioctl
 
#ifdef CONFIG_DRM_FBDEV_EMULATION
void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
               unsigned int preferred_bpp,
               const struct drm_fb_helper_funcs *funcs);
void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper);
int drm_fb_helper_init(struct drm_device *dev, struct drm_fb_helper *helper);
void drm_fb_helper_fini(struct drm_fb_helper *helper);
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);
 
int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper,
                          bool force);
 
void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper);
void drm_fb_helper_fill_info(struct fb_info *info,
                 struct drm_fb_helper *fb_helper,
                 struct drm_fb_helper_surface_size *sizes);
 
void drm_fb_helper_damage_range(struct fb_info *info, off_t off, size_t len);
void drm_fb_helper_damage_area(struct fb_info *info, u32 x, u32 y, u32 width, u32 height);
 
#ifdef CONFIG_FB_DEFERRED_IO
void drm_fb_helper_deferred_io(struct fb_info *info, struct list_head *pagereflist);
#endif
 
void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
                    bool suspend);
 
int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
 
int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
            unsigned long arg);
 
int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper);
bool drm_fb_helper_gem_is_fb(const struct drm_fb_helper *fb_helper,
                 const struct drm_gem_object *obj);
#else
static inline bool drm_fb_helper_gem_is_fb(const struct drm_fb_helper *fb_helper,
                       const struct drm_gem_object *obj)
{
    return false;
}
#endif
 
#endif