[deliverable/linux.git] / drivers / gpu / drm / drm_fb_cma_helper.c

/*
 * drm kms/fb cma (contiguous memory allocator) helper functions
 *
 * Copyright (C) 2012 Analog Device Inc.
 *   Author: Lars-Peter Clausen <lars@metafoo.de>
 *
 * Based on udl_fbdev.c
 *  Copyright (C) 2012 Red Hat
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <drm/drmP.h>
#include <drm/drm_crtc.h>
#include <drm/drm_fb_helper.h>
#include <drm/drm_crtc_helper.h>
#include <drm/drm_gem_cma_helper.h>
#include <drm/drm_fb_cma_helper.h>
#include <linux/dma-mapping.h>
#include <linux/module.h>

#define DEFAULT_FBDEFIO_DELAY_MS 50

struct drm_fb_cma {
	struct drm_framebuffer		fb;
	struct drm_gem_cma_object	*obj[4];
};

struct drm_fbdev_cma {
	struct drm_fb_helper	fb_helper;
	struct drm_fb_cma	*fb;
};

/**
 * DOC: framebuffer cma helper functions
 *
 * Provides helper functions for creating a cma (contiguous memory allocator)
 * backed framebuffer.
 *
 * drm_fb_cma_create() is used in the &drm_mode_config_funcs ->fb_create
 * callback function to create a cma backed framebuffer.
 *
 * An fbdev framebuffer backed by cma is also available by calling
 * drm_fbdev_cma_init(). drm_fbdev_cma_fini() tears it down.
 * If the &drm_framebuffer_funcs ->dirty callback is set, fb_deferred_io
 * will be set up automatically. dirty() is called by
 * drm_fb_helper_deferred_io() in process context (struct delayed_work).
 *
 * Example fbdev deferred io code::
 *
 *     static int driver_fbdev_fb_dirty(struct drm_framebuffer *fb,
 *                                      struct drm_file *file_priv,
 *                                      unsigned flags, unsigned color,
 *                                      struct drm_clip_rect *clips,
 *                                      unsigned num_clips)
 *     {
 *         struct drm_gem_cma_object *cma = drm_fb_cma_get_gem_obj(fb, 0);
 *         ... push changes ...
 *         return 0;
 *     }
 *
 *     static struct drm_framebuffer_funcs driver_fbdev_fb_funcs = {
 *         .destroy       = drm_fb_cma_destroy,
 *         .create_handle = drm_fb_cma_create_handle,
 *         .dirty         = driver_fbdev_fb_dirty,
 *     };
 *
 *     static int driver_fbdev_create(struct drm_fb_helper *helper,
 *             struct drm_fb_helper_surface_size *sizes)
 *     {
 *         return drm_fbdev_cma_create_with_funcs(helper, sizes,
 *                                                &driver_fbdev_fb_funcs);
 *     }
 *
 *     static const struct drm_fb_helper_funcs driver_fb_helper_funcs = {
 *         .fb_probe = driver_fbdev_create,
 *     };
 *
 *     Initialize:
 *     fbdev = drm_fbdev_cma_init_with_funcs(dev, 16,
 *                                           dev->mode_config.num_crtc,
 *                                           dev->mode_config.num_connector,
 *                                           &driver_fb_helper_funcs);
 *
 */

static inline struct drm_fbdev_cma *to_fbdev_cma(struct drm_fb_helper *helper)
{
	return container_of(helper, struct drm_fbdev_cma, fb_helper);
}

static inline struct drm_fb_cma *to_fb_cma(struct drm_framebuffer *fb)
{
	return container_of(fb, struct drm_fb_cma, fb);
}

void drm_fb_cma_destroy(struct drm_framebuffer *fb)
{
	struct drm_fb_cma *fb_cma = to_fb_cma(fb);
	int i;

	for (i = 0; i < 4; i++) {
		if (fb_cma->obj[i])
			drm_gem_object_unreference_unlocked(&fb_cma->obj[i]->base);
	}

	drm_framebuffer_cleanup(fb);
	kfree(fb_cma);
}
EXPORT_SYMBOL(drm_fb_cma_destroy);

int drm_fb_cma_create_handle(struct drm_framebuffer *fb,
	struct drm_file *file_priv, unsigned int *handle)
{
	struct drm_fb_cma *fb_cma = to_fb_cma(fb);

	return drm_gem_handle_create(file_priv,
			&fb_cma->obj[0]->base, handle);
}
EXPORT_SYMBOL(drm_fb_cma_create_handle);

static struct drm_framebuffer_funcs drm_fb_cma_funcs = {
	.destroy	= drm_fb_cma_destroy,
	.create_handle	= drm_fb_cma_create_handle,
};

static struct drm_fb_cma *drm_fb_cma_alloc(struct drm_device *dev,
	const struct drm_mode_fb_cmd2 *mode_cmd,
	struct drm_gem_cma_object **obj,
	unsigned int num_planes, const struct drm_framebuffer_funcs *funcs)
{
	struct drm_fb_cma *fb_cma;
	int ret;
	int i;

	fb_cma = kzalloc(sizeof(*fb_cma), GFP_KERNEL);
	if (!fb_cma)
		return ERR_PTR(-ENOMEM);

	drm_helper_mode_fill_fb_struct(&fb_cma->fb, mode_cmd);

	for (i = 0; i < num_planes; i++)
		fb_cma->obj[i] = obj[i];

	ret = drm_framebuffer_init(dev, &fb_cma->fb, funcs);
	if (ret) {
		dev_err(dev->dev, "Failed to initialize framebuffer: %d\n", ret);
		kfree(fb_cma);
		return ERR_PTR(ret);
	}

	return fb_cma;
}

/**
 * drm_fb_cma_create_with_funcs() - helper function for the
 *                                  &drm_mode_config_funcs ->fb_create
 *                                  callback function
 * @dev: DRM device
 * @file_priv: drm file for the ioctl call
 * @mode_cmd: metadata from the userspace fb creation request
 * @funcs: vtable to be used for the new framebuffer object
 *
 * This can be used to set &drm_framebuffer_funcs for drivers that need the
 * dirty() callback. Use drm_fb_cma_create() if you don't need to change
 * &drm_framebuffer_funcs.
 */
struct drm_framebuffer *drm_fb_cma_create_with_funcs(struct drm_device *dev,
	struct drm_file *file_priv, const struct drm_mode_fb_cmd2 *mode_cmd,
	const struct drm_framebuffer_funcs *funcs)
{
	struct drm_fb_cma *fb_cma;
	struct drm_gem_cma_object *objs[4];
	struct drm_gem_object *obj;
	unsigned int hsub;
	unsigned int vsub;
	int ret;
	int i;

	hsub = drm_format_horz_chroma_subsampling(mode_cmd->pixel_format);
	vsub = drm_format_vert_chroma_subsampling(mode_cmd->pixel_format);

	for (i = 0; i < drm_format_num_planes(mode_cmd->pixel_format); i++) {
		unsigned int width = mode_cmd->width / (i ? hsub : 1);
		unsigned int height = mode_cmd->height / (i ? vsub : 1);
		unsigned int min_size;

		obj = drm_gem_object_lookup(file_priv, mode_cmd->handles[i]);
		if (!obj) {
			dev_err(dev->dev, "Failed to lookup GEM object\n");
			ret = -ENXIO;
			goto err_gem_object_unreference;
		}

		min_size = (height - 1) * mode_cmd->pitches[i]
			 + width * drm_format_plane_cpp(mode_cmd->pixel_format, i)
			 + mode_cmd->offsets[i];

		if (obj->size < min_size) {
			drm_gem_object_unreference_unlocked(obj);
			ret = -EINVAL;
			goto err_gem_object_unreference;
		}
		objs[i] = to_drm_gem_cma_obj(obj);
	}

	fb_cma = drm_fb_cma_alloc(dev, mode_cmd, objs, i, funcs);
	if (IS_ERR(fb_cma)) {
		ret = PTR_ERR(fb_cma);
		goto err_gem_object_unreference;
	}

	return &fb_cma->fb;

err_gem_object_unreference:
	for (i--; i >= 0; i--)
		drm_gem_object_unreference_unlocked(&objs[i]->base);
	return ERR_PTR(ret);
}
EXPORT_SYMBOL_GPL(drm_fb_cma_create_with_funcs);

/**
 * drm_fb_cma_create() - &drm_mode_config_funcs ->fb_create callback function
 * @dev: DRM device
 * @file_priv: drm file for the ioctl call
 * @mode_cmd: metadata from the userspace fb creation request
 *
 * If your hardware has special alignment or pitch requirements these should be
 * checked before calling this function. Use drm_fb_cma_create_with_funcs() if
 * you need to set &drm_framebuffer_funcs ->dirty.
 */
struct drm_framebuffer *drm_fb_cma_create(struct drm_device *dev,
	struct drm_file *file_priv, const struct drm_mode_fb_cmd2 *mode_cmd)
{
	return drm_fb_cma_create_with_funcs(dev, file_priv, mode_cmd,
					    &drm_fb_cma_funcs);
}
EXPORT_SYMBOL_GPL(drm_fb_cma_create);

/**
 * drm_fb_cma_get_gem_obj() - Get CMA GEM object for framebuffer
 * @fb: The framebuffer
 * @plane: Which plane
 *
 * Return the CMA GEM object for given framebuffer.
 *
 * This function will usually be called from the CRTC callback functions.
 */
struct drm_gem_cma_object *drm_fb_cma_get_gem_obj(struct drm_framebuffer *fb,
						  unsigned int plane)
{
	struct drm_fb_cma *fb_cma = to_fb_cma(fb);

	if (plane >= 4)
		return NULL;

	return fb_cma->obj[plane];
}
EXPORT_SYMBOL_GPL(drm_fb_cma_get_gem_obj);

#ifdef CONFIG_DEBUG_FS
static void drm_fb_cma_describe(struct drm_framebuffer *fb, struct seq_file *m)
{
	struct drm_fb_cma *fb_cma = to_fb_cma(fb);
	int i, n = drm_format_num_planes(fb->pixel_format);

	seq_printf(m, "fb: %dx%d@%4.4s\n", fb->width, fb->height,
			(char *)&fb->pixel_format);

	for (i = 0; i < n; i++) {
		seq_printf(m, "   %d: offset=%d pitch=%d, obj: ",
				i, fb->offsets[i], fb->pitches[i]);
		drm_gem_cma_describe(fb_cma->obj[i], m);
	}
}

/**
 * drm_fb_cma_debugfs_show() - Helper to list CMA framebuffer objects
 *			       in debugfs.
 * @m: output file
 * @arg: private data for the callback
 */
int drm_fb_cma_debugfs_show(struct seq_file *m, void *arg)
{
	struct drm_info_node *node = (struct drm_info_node *) m->private;
	struct drm_device *dev = node->minor->dev;
	struct drm_framebuffer *fb;

	mutex_lock(&dev->mode_config.fb_lock);
	drm_for_each_fb(fb, dev)
		drm_fb_cma_describe(fb, m);
	mutex_unlock(&dev->mode_config.fb_lock);

	return 0;
}
EXPORT_SYMBOL_GPL(drm_fb_cma_debugfs_show);
#endif

static int drm_fb_cma_mmap(struct fb_info *info, struct vm_area_struct *vma)
{
	return dma_mmap_writecombine(info->device, vma, info->screen_base,
				     info->fix.smem_start, info->fix.smem_len);
}

static struct fb_ops drm_fbdev_cma_ops = {
	.owner		= THIS_MODULE,
	.fb_fillrect	= drm_fb_helper_sys_fillrect,
	.fb_copyarea	= drm_fb_helper_sys_copyarea,
	.fb_imageblit	= drm_fb_helper_sys_imageblit,
	.fb_check_var	= drm_fb_helper_check_var,
	.fb_set_par	= drm_fb_helper_set_par,
	.fb_blank	= drm_fb_helper_blank,
	.fb_pan_display	= drm_fb_helper_pan_display,
	.fb_setcmap	= drm_fb_helper_setcmap,
	.fb_mmap	= drm_fb_cma_mmap,
};

static int drm_fbdev_cma_deferred_io_mmap(struct fb_info *info,
					  struct vm_area_struct *vma)
{
	fb_deferred_io_mmap(info, vma);
	vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);

	return 0;
}

static int drm_fbdev_cma_defio_init(struct fb_info *fbi,
				    struct drm_gem_cma_object *cma_obj)
{
	struct fb_deferred_io *fbdefio;
	struct fb_ops *fbops;

	/*
	 * Per device structures are needed because:
	 * fbops: fb_deferred_io_cleanup() clears fbops.fb_mmap
	 * fbdefio: individual delays
	 */
	fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
	fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
	if (!fbdefio || !fbops) {
		kfree(fbdefio);
		kfree(fbops);
		return -ENOMEM;
	}

	/* can't be offset from vaddr since dirty() uses cma_obj */
	fbi->screen_buffer = cma_obj->vaddr;
	/* fb_deferred_io_fault() needs a physical address */
	fbi->fix.smem_start = page_to_phys(virt_to_page(fbi->screen_buffer));

	*fbops = *fbi->fbops;
	fbi->fbops = fbops;

	fbdefio->delay = msecs_to_jiffies(DEFAULT_FBDEFIO_DELAY_MS);
	fbdefio->deferred_io = drm_fb_helper_deferred_io;
	fbi->fbdefio = fbdefio;
	fb_deferred_io_init(fbi);
	fbi->fbops->fb_mmap = drm_fbdev_cma_deferred_io_mmap;

	return 0;
}

static void drm_fbdev_cma_defio_fini(struct fb_info *fbi)
{
	if (!fbi->fbdefio)
		return;

	fb_deferred_io_cleanup(fbi);
	kfree(fbi->fbdefio);
	kfree(fbi->fbops);
}

/*
 * For use in a (struct drm_fb_helper_funcs *)->fb_probe callback function that
 * needs custom struct drm_framebuffer_funcs, like dirty() for deferred_io use.
 */
int drm_fbdev_cma_create_with_funcs(struct drm_fb_helper *helper,
	struct drm_fb_helper_surface_size *sizes,
	const struct drm_framebuffer_funcs *funcs)
{
	struct drm_fbdev_cma *fbdev_cma = to_fbdev_cma(helper);
	struct drm_mode_fb_cmd2 mode_cmd = { 0 };
	struct drm_device *dev = helper->dev;
	struct drm_gem_cma_object *obj;
	struct drm_framebuffer *fb;
	unsigned int bytes_per_pixel;
	unsigned long offset;
	struct fb_info *fbi;
	size_t size;
	int ret;

	DRM_DEBUG_KMS("surface width(%d), height(%d) and bpp(%d)\n",
			sizes->surface_width, sizes->surface_height,
			sizes->surface_bpp);

	bytes_per_pixel = DIV_ROUND_UP(sizes->surface_bpp, 8);

	mode_cmd.width = sizes->surface_width;
	mode_cmd.height = sizes->surface_height;
	mode_cmd.pitches[0] = sizes->surface_width * bytes_per_pixel;
	mode_cmd.pixel_format = drm_mode_legacy_fb_format(sizes->surface_bpp,
		sizes->surface_depth);

	size = mode_cmd.pitches[0] * mode_cmd.height;
	obj = drm_gem_cma_create(dev, size);
	if (IS_ERR(obj))
		return -ENOMEM;

	fbi = drm_fb_helper_alloc_fbi(helper);
	if (IS_ERR(fbi)) {
		ret = PTR_ERR(fbi);
		goto err_gem_free_object;
	}

	fbdev_cma->fb = drm_fb_cma_alloc(dev, &mode_cmd, &obj, 1, funcs);
	if (IS_ERR(fbdev_cma->fb)) {
		dev_err(dev->dev, "Failed to allocate DRM framebuffer.\n");
		ret = PTR_ERR(fbdev_cma->fb);
		goto err_fb_info_destroy;
	}

	fb = &fbdev_cma->fb->fb;
	helper->fb = fb;

	fbi->par = helper;
	fbi->flags = FBINFO_FLAG_DEFAULT;
	fbi->fbops = &drm_fbdev_cma_ops;

	drm_fb_helper_fill_fix(fbi, fb->pitches[0], fb->depth);
	drm_fb_helper_fill_var(fbi, helper, sizes->fb_width, sizes->fb_height);

	offset = fbi->var.xoffset * bytes_per_pixel;
	offset += fbi->var.yoffset * fb->pitches[0];

	dev->mode_config.fb_base = (resource_size_t)obj->paddr;
	fbi->screen_base = obj->vaddr + offset;
	fbi->fix.smem_start = (unsigned long)(obj->paddr + offset);
	fbi->screen_size = size;
	fbi->fix.smem_len = size;

	if (funcs->dirty) {
		ret = drm_fbdev_cma_defio_init(fbi, obj);
		if (ret)
			goto err_cma_destroy;
	}

	return 0;

err_cma_destroy:
	drm_framebuffer_unregister_private(&fbdev_cma->fb->fb);
	drm_fb_cma_destroy(&fbdev_cma->fb->fb);
err_fb_info_destroy:
	drm_fb_helper_release_fbi(helper);
err_gem_free_object:
	drm_gem_object_unreference_unlocked(&obj->base);
	return ret;
}
EXPORT_SYMBOL(drm_fbdev_cma_create_with_funcs);

static int drm_fbdev_cma_create(struct drm_fb_helper *helper,
	struct drm_fb_helper_surface_size *sizes)
{
	return drm_fbdev_cma_create_with_funcs(helper, sizes, &drm_fb_cma_funcs);
}

static const struct drm_fb_helper_funcs drm_fb_cma_helper_funcs = {
	.fb_probe = drm_fbdev_cma_create,
};

/**
 * drm_fbdev_cma_init_with_funcs() - Allocate and initializes a drm_fbdev_cma struct
 * @dev: DRM device
 * @preferred_bpp: Preferred bits per pixel for the device
 * @num_crtc: Number of CRTCs
 * @max_conn_count: Maximum number of connectors
 * @funcs: fb helper functions, in particular fb_probe()
 *
 * Returns a newly allocated drm_fbdev_cma struct or a ERR_PTR.
 */
struct drm_fbdev_cma *drm_fbdev_cma_init_with_funcs(struct drm_device *dev,
	unsigned int preferred_bpp, unsigned int num_crtc,
	unsigned int max_conn_count, const struct drm_fb_helper_funcs *funcs)
{
	struct drm_fbdev_cma *fbdev_cma;
	struct drm_fb_helper *helper;
	int ret;

	fbdev_cma = kzalloc(sizeof(*fbdev_cma), GFP_KERNEL);
	if (!fbdev_cma) {
		dev_err(dev->dev, "Failed to allocate drm fbdev.\n");
		return ERR_PTR(-ENOMEM);
	}

	helper = &fbdev_cma->fb_helper;

	drm_fb_helper_prepare(dev, helper, funcs);

	ret = drm_fb_helper_init(dev, helper, num_crtc, max_conn_count);
	if (ret < 0) {
		dev_err(dev->dev, "Failed to initialize drm fb helper.\n");
		goto err_free;
	}

	ret = drm_fb_helper_single_add_all_connectors(helper);
	if (ret < 0) {
		dev_err(dev->dev, "Failed to add connectors.\n");
		goto err_drm_fb_helper_fini;

	}

	ret = drm_fb_helper_initial_config(helper, preferred_bpp);
	if (ret < 0) {
		dev_err(dev->dev, "Failed to set initial hw configuration.\n");
		goto err_drm_fb_helper_fini;
	}

	return fbdev_cma;

err_drm_fb_helper_fini:
	drm_fb_helper_fini(helper);
err_free:
	kfree(fbdev_cma);

	return ERR_PTR(ret);
}
EXPORT_SYMBOL_GPL(drm_fbdev_cma_init_with_funcs);

/**
 * drm_fbdev_cma_init() - Allocate and initializes a drm_fbdev_cma struct
 * @dev: DRM device
 * @preferred_bpp: Preferred bits per pixel for the device
 * @num_crtc: Number of CRTCs
 * @max_conn_count: Maximum number of connectors
 *
 * Returns a newly allocated drm_fbdev_cma struct or a ERR_PTR.
 */
struct drm_fbdev_cma *drm_fbdev_cma_init(struct drm_device *dev,
	unsigned int preferred_bpp, unsigned int num_crtc,
	unsigned int max_conn_count)
{
	return drm_fbdev_cma_init_with_funcs(dev, preferred_bpp, num_crtc,
				max_conn_count, &drm_fb_cma_helper_funcs);
}
EXPORT_SYMBOL_GPL(drm_fbdev_cma_init);

/**
 * drm_fbdev_cma_fini() - Free drm_fbdev_cma struct
 * @fbdev_cma: The drm_fbdev_cma struct
 */
void drm_fbdev_cma_fini(struct drm_fbdev_cma *fbdev_cma)
{
	drm_fb_helper_unregister_fbi(&fbdev_cma->fb_helper);
	drm_fbdev_cma_defio_fini(fbdev_cma->fb_helper.fbdev);
	drm_fb_helper_release_fbi(&fbdev_cma->fb_helper);

	if (fbdev_cma->fb) {
		drm_framebuffer_unregister_private(&fbdev_cma->fb->fb);
		drm_fb_cma_destroy(&fbdev_cma->fb->fb);
	}

	drm_fb_helper_fini(&fbdev_cma->fb_helper);
	kfree(fbdev_cma);
}
EXPORT_SYMBOL_GPL(drm_fbdev_cma_fini);

/**
 * drm_fbdev_cma_restore_mode() - Restores initial framebuffer mode
 * @fbdev_cma: The drm_fbdev_cma struct, may be NULL
 *
 * This function is usually called from the DRM drivers lastclose callback.
 */
void drm_fbdev_cma_restore_mode(struct drm_fbdev_cma *fbdev_cma)
{
	if (fbdev_cma)
		drm_fb_helper_restore_fbdev_mode_unlocked(&fbdev_cma->fb_helper);
}
EXPORT_SYMBOL_GPL(drm_fbdev_cma_restore_mode);

/**
 * drm_fbdev_cma_hotplug_event() - Poll for hotpulug events
 * @fbdev_cma: The drm_fbdev_cma struct, may be NULL
 *
 * This function is usually called from the DRM drivers output_poll_changed
 * callback.
 */
void drm_fbdev_cma_hotplug_event(struct drm_fbdev_cma *fbdev_cma)
{
	if (fbdev_cma)
		drm_fb_helper_hotplug_event(&fbdev_cma->fb_helper);
}
EXPORT_SYMBOL_GPL(drm_fbdev_cma_hotplug_event);

/**
 * drm_fbdev_cma_set_suspend - wrapper around drm_fb_helper_set_suspend
 * @fbdev_cma: The drm_fbdev_cma struct, may be NULL
 * @state: desired state, zero to resume, non-zero to suspend
 *
 * Calls drm_fb_helper_set_suspend, which is a wrapper around
 * fb_set_suspend implemented by fbdev core.
 */
void drm_fbdev_cma_set_suspend(struct drm_fbdev_cma *fbdev_cma, int state)
{
	if (fbdev_cma)
		drm_fb_helper_set_suspend(&fbdev_cma->fb_helper, state);
}
EXPORT_SYMBOL(drm_fbdev_cma_set_suspend);
Commit	Line	Data
2e3b3c42 LPC	1	/*
	2	* drm kms/fb cma (contiguous memory allocator) helper functions
	3	*
	4	* Copyright (C) 2012 Analog Device Inc.
	5	* Author: Lars-Peter Clausen <lars@metafoo.de>
	6	*
	7	* Based on udl_fbdev.c
	8	* Copyright (C) 2012 Red Hat
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public License
	12	* as published by the Free Software Foundation; either version 2
	13	* of the License, or (at your option) any later version.
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*/
	19
	20	#include <drm/drmP.h>
	21	#include <drm/drm_crtc.h>
	22	#include <drm/drm_fb_helper.h>
	23	#include <drm/drm_crtc_helper.h>
	24	#include <drm/drm_gem_cma_helper.h>
	25	#include <drm/drm_fb_cma_helper.h>
ce0c5757	26	#include <linux/dma-mapping.h>
2e3b3c42 LPC	27	#include <linux/module.h>
2e3b3c42 LPC	28
199c7717 NT	29	#define DEFAULT_FBDEFIO_DELAY_MS 50
199c7717 NT	30
2e3b3c42 LPC	31	struct drm_fb_cma {
	32	struct drm_framebuffer fb;
	33	struct drm_gem_cma_object *obj[4];
	34	};
	35
	36	struct drm_fbdev_cma {
	37	struct drm_fb_helper fb_helper;
	38	struct drm_fb_cma *fb;
	39	};
	40
199c7717 NT	41	/**
	42	* DOC: framebuffer cma helper functions
	43	*
	44	* Provides helper functions for creating a cma (contiguous memory allocator)
	45	* backed framebuffer.
	46	*
02da16d0 NT	47	* drm_fb_cma_create() is used in the &drm_mode_config_funcs ->fb_create
02da16d0 NT	48	* callback function to create a cma backed framebuffer.
199c7717 NT	49	*
	50	* An fbdev framebuffer backed by cma is also available by calling
	51	* drm_fbdev_cma_init(). drm_fbdev_cma_fini() tears it down.
02da16d0	52	* If the &drm_framebuffer_funcs ->dirty callback is set, fb_deferred_io
199c7717 NT	53	* will be set up automatically. dirty() is called by
	54	* drm_fb_helper_deferred_io() in process context (struct delayed_work).
	55	*
da5335b8	56	* Example fbdev deferred io code::
199c7717 NT	57	*
	58	* static int driver_fbdev_fb_dirty(struct drm_framebuffer *fb,
	59	* struct drm_file *file_priv,
	60	* unsigned flags, unsigned color,
	61	* struct drm_clip_rect *clips,
	62	* unsigned num_clips)
	63	* {
	64	* struct drm_gem_cma_object *cma = drm_fb_cma_get_gem_obj(fb, 0);
	65	* ... push changes ...
	66	* return 0;
	67	* }
	68	*
	69	* static struct drm_framebuffer_funcs driver_fbdev_fb_funcs = {
	70	* .destroy = drm_fb_cma_destroy,
	71	* .create_handle = drm_fb_cma_create_handle,
	72	* .dirty = driver_fbdev_fb_dirty,
	73	* };
	74	*
	75	* static int driver_fbdev_create(struct drm_fb_helper *helper,
	76	* struct drm_fb_helper_surface_size *sizes)
	77	* {
	78	* return drm_fbdev_cma_create_with_funcs(helper, sizes,
	79	* &driver_fbdev_fb_funcs);
	80	* }
	81	*
	82	* static const struct drm_fb_helper_funcs driver_fb_helper_funcs = {
	83	* .fb_probe = driver_fbdev_create,
	84	* };
	85	*
	86	* Initialize:
	87	* fbdev = drm_fbdev_cma_init_with_funcs(dev, 16,
	88	* dev->mode_config.num_crtc,
	89	* dev->mode_config.num_connector,
	90	* &driver_fb_helper_funcs);
	91	*
	92	*/
	93
2e3b3c42 LPC	94	static inline struct drm_fbdev_cma to_fbdev_cma(struct drm_fb_helper helper)
	95	{
	96	return container_of(helper, struct drm_fbdev_cma, fb_helper);
	97	}
	98
	99	static inline struct drm_fb_cma to_fb_cma(struct drm_framebuffer fb)
	100	{
	101	return container_of(fb, struct drm_fb_cma, fb);
	102	}
	103
199c7717	104	void drm_fb_cma_destroy(struct drm_framebuffer *fb)
2e3b3c42 LPC	105	{
	106	struct drm_fb_cma *fb_cma = to_fb_cma(fb);
	107	int i;
	108
	109	for (i = 0; i < 4; i++) {
	110	if (fb_cma->obj[i])
	111	drm_gem_object_unreference_unlocked(&fb_cma->obj[i]->base);
	112	}
	113
	114	drm_framebuffer_cleanup(fb);
	115	kfree(fb_cma);
	116	}
199c7717	117	EXPORT_SYMBOL(drm_fb_cma_destroy);
2e3b3c42	118
199c7717	119	int drm_fb_cma_create_handle(struct drm_framebuffer *fb,
2e3b3c42 LPC	120	struct drm_file file_priv, unsigned int handle)
	121	{
	122	struct drm_fb_cma *fb_cma = to_fb_cma(fb);
	123
	124	return drm_gem_handle_create(file_priv,
	125	&fb_cma->obj[0]->base, handle);
	126	}
199c7717	127	EXPORT_SYMBOL(drm_fb_cma_create_handle);
2e3b3c42 LPC	128
	129	static struct drm_framebuffer_funcs drm_fb_cma_funcs = {
	130	.destroy = drm_fb_cma_destroy,
	131	.create_handle = drm_fb_cma_create_handle,
	132	};
	133
	134	static struct drm_fb_cma drm_fb_cma_alloc(struct drm_device dev,
70c0616d CIK	135	const struct drm_mode_fb_cmd2 *mode_cmd,
70c0616d CIK	136	struct drm_gem_cma_object **obj,
fdce1846	137	unsigned int num_planes, const struct drm_framebuffer_funcs *funcs)
2e3b3c42 LPC	138	{
	139	struct drm_fb_cma *fb_cma;
	140	int ret;
	141	int i;
	142
	143	fb_cma = kzalloc(sizeof(*fb_cma), GFP_KERNEL);
	144	if (!fb_cma)
	145	return ERR_PTR(-ENOMEM);
	146
c7d73f6a DV	147	drm_helper_mode_fill_fb_struct(&fb_cma->fb, mode_cmd);
	148
	149	for (i = 0; i < num_planes; i++)
	150	fb_cma->obj[i] = obj[i];
	151
199c7717	152	ret = drm_framebuffer_init(dev, &fb_cma->fb, funcs);
2e3b3c42	153	if (ret) {
8b513d0c	154	dev_err(dev->dev, "Failed to initialize framebuffer: %d\n", ret);
2e3b3c42 LPC	155	kfree(fb_cma);
	156	return ERR_PTR(ret);
	157	}
	158
2e3b3c42 LPC	159	return fb_cma;
	160	}
	161
	162	/**
3995b395 NT	163	* drm_fb_cma_create_with_funcs() - helper function for the
	164	* &drm_mode_config_funcs ->fb_create
	165	* callback function
890358a6 DV	166	* @dev: DRM device
	167	* @file_priv: drm file for the ioctl call
	168	* @mode_cmd: metadata from the userspace fb creation request
	169	* @funcs: vtable to be used for the new framebuffer object
2e3b3c42	170	*
3995b395 NT	171	* This can be used to set &drm_framebuffer_funcs for drivers that need the
	172	* dirty() callback. Use drm_fb_cma_create() if you don't need to change
	173	* &drm_framebuffer_funcs.
2e3b3c42	174	*/
3995b395 NT	175	struct drm_framebuffer drm_fb_cma_create_with_funcs(struct drm_device dev,
	176	struct drm_file file_priv, const struct drm_mode_fb_cmd2 mode_cmd,
	177	const struct drm_framebuffer_funcs *funcs)
2e3b3c42 LPC	178	{
	179	struct drm_fb_cma *fb_cma;
	180	struct drm_gem_cma_object *objs[4];
	181	struct drm_gem_object *obj;
	182	unsigned int hsub;
	183	unsigned int vsub;
	184	int ret;
	185	int i;
	186
	187	hsub = drm_format_horz_chroma_subsampling(mode_cmd->pixel_format);
	188	vsub = drm_format_vert_chroma_subsampling(mode_cmd->pixel_format);
	189
	190	for (i = 0; i < drm_format_num_planes(mode_cmd->pixel_format); i++) {
	191	unsigned int width = mode_cmd->width / (i ? hsub : 1);
	192	unsigned int height = mode_cmd->height / (i ? vsub : 1);
	193	unsigned int min_size;
	194
a8ad0bd8	195	obj = drm_gem_object_lookup(file_priv, mode_cmd->handles[i]);
2e3b3c42 LPC	196	if (!obj) {
	197	dev_err(dev->dev, "Failed to lookup GEM object\n");
	198	ret = -ENXIO;
	199	goto err_gem_object_unreference;
	200	}
	201
	202	min_size = (height - 1) * mode_cmd->pitches[i]
	203	+ width * drm_format_plane_cpp(mode_cmd->pixel_format, i)
	204	+ mode_cmd->offsets[i];
	205
	206	if (obj->size < min_size) {
	207	drm_gem_object_unreference_unlocked(obj);
	208	ret = -EINVAL;
	209	goto err_gem_object_unreference;
	210	}
	211	objs[i] = to_drm_gem_cma_obj(obj);
	212	}
	213
3995b395	214	fb_cma = drm_fb_cma_alloc(dev, mode_cmd, objs, i, funcs);
2e3b3c42 LPC	215	if (IS_ERR(fb_cma)) {
	216	ret = PTR_ERR(fb_cma);
	217	goto err_gem_object_unreference;
	218	}
	219
	220	return &fb_cma->fb;
	221
	222	err_gem_object_unreference:
	223	for (i--; i >= 0; i--)
	224	drm_gem_object_unreference_unlocked(&objs[i]->base);
	225	return ERR_PTR(ret);
	226	}
3995b395 NT	227	EXPORT_SYMBOL_GPL(drm_fb_cma_create_with_funcs);
	228
	229	/**
	230	* drm_fb_cma_create() - &drm_mode_config_funcs ->fb_create callback function
890358a6 DV	231	* @dev: DRM device
	232	* @file_priv: drm file for the ioctl call
	233	* @mode_cmd: metadata from the userspace fb creation request
3995b395 NT	234	*
	235	* If your hardware has special alignment or pitch requirements these should be
	236	* checked before calling this function. Use drm_fb_cma_create_with_funcs() if
	237	* you need to set &drm_framebuffer_funcs ->dirty.
	238	*/
	239	struct drm_framebuffer drm_fb_cma_create(struct drm_device dev,
	240	struct drm_file file_priv, const struct drm_mode_fb_cmd2 mode_cmd)
	241	{
	242	return drm_fb_cma_create_with_funcs(dev, file_priv, mode_cmd,
	243	&drm_fb_cma_funcs);
	244	}
2e3b3c42 LPC	245	EXPORT_SYMBOL_GPL(drm_fb_cma_create);
	246
	247	/**
	248	* drm_fb_cma_get_gem_obj() - Get CMA GEM object for framebuffer
	249	* @fb: The framebuffer
	250	* @plane: Which plane
	251	*
	252	* Return the CMA GEM object for given framebuffer.
	253	*
	254	* This function will usually be called from the CRTC callback functions.
	255	*/
	256	struct drm_gem_cma_object drm_fb_cma_get_gem_obj(struct drm_framebuffer fb,
890358a6	257	unsigned int plane)
2e3b3c42 LPC	258	{
	259	struct drm_fb_cma *fb_cma = to_fb_cma(fb);
	260
	261	if (plane >= 4)
	262	return NULL;
	263
	264	return fb_cma->obj[plane];
	265	}
	266	EXPORT_SYMBOL_GPL(drm_fb_cma_get_gem_obj);
	267
6f646095	268	#ifdef CONFIG_DEBUG_FS
2c9c52e8	269	static void drm_fb_cma_describe(struct drm_framebuffer fb, struct seq_file m)
6f646095 RC	270	{
	271	struct drm_fb_cma *fb_cma = to_fb_cma(fb);
	272	int i, n = drm_format_num_planes(fb->pixel_format);
	273
	274	seq_printf(m, "fb: %dx%d@%4.4s\n", fb->width, fb->height,
	275	(char *)&fb->pixel_format);
	276
	277	for (i = 0; i < n; i++) {
	278	seq_printf(m, " %d: offset=%d pitch=%d, obj: ",
	279	i, fb->offsets[i], fb->pitches[i]);
	280	drm_gem_cma_describe(fb_cma->obj[i], m);
	281	}
	282	}
6f646095 RC	283
	284	/**
	285	* drm_fb_cma_debugfs_show() - Helper to list CMA framebuffer objects
890358a6 DV	286	* in debugfs.
	287	* @m: output file
	288	* @arg: private data for the callback
6f646095 RC	289	*/
	290	int drm_fb_cma_debugfs_show(struct seq_file m, void arg)
	291	{
	292	struct drm_info_node node = (struct drm_info_node ) m->private;
	293	struct drm_device *dev = node->minor->dev;
	294	struct drm_framebuffer *fb;
6f646095	295
9e75c0ef	296	mutex_lock(&dev->mode_config.fb_lock);
e4f62546	297	drm_for_each_fb(fb, dev)
6f646095	298	drm_fb_cma_describe(fb, m);
9e75c0ef	299	mutex_unlock(&dev->mode_config.fb_lock);
6f646095 RC	300
	301	return 0;
	302	}
	303	EXPORT_SYMBOL_GPL(drm_fb_cma_debugfs_show);
	304	#endif
	305
ce0c5757 RM	306	static int drm_fb_cma_mmap(struct fb_info info, struct vm_area_struct vma)
	307	{
	308	return dma_mmap_writecombine(info->device, vma, info->screen_base,
	309	info->fix.smem_start, info->fix.smem_len);
	310	}
	311
2e3b3c42 LPC	312	static struct fb_ops drm_fbdev_cma_ops = {
2e3b3c42 LPC	313	.owner = THIS_MODULE,
85f2edf2 AT	314	.fb_fillrect = drm_fb_helper_sys_fillrect,
	315	.fb_copyarea = drm_fb_helper_sys_copyarea,
	316	.fb_imageblit = drm_fb_helper_sys_imageblit,
2e3b3c42 LPC	317	.fb_check_var = drm_fb_helper_check_var,
	318	.fb_set_par = drm_fb_helper_set_par,
	319	.fb_blank = drm_fb_helper_blank,
	320	.fb_pan_display = drm_fb_helper_pan_display,
	321	.fb_setcmap = drm_fb_helper_setcmap,
ce0c5757	322	.fb_mmap = drm_fb_cma_mmap,
2e3b3c42 LPC	323	};
2e3b3c42 LPC	324
199c7717 NT	325	static int drm_fbdev_cma_deferred_io_mmap(struct fb_info *info,
	326	struct vm_area_struct *vma)
	327	{
	328	fb_deferred_io_mmap(info, vma);
	329	vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
	330
	331	return 0;
	332	}
	333
	334	static int drm_fbdev_cma_defio_init(struct fb_info *fbi,
	335	struct drm_gem_cma_object *cma_obj)
	336	{
	337	struct fb_deferred_io *fbdefio;
	338	struct fb_ops *fbops;
	339
	340	/*
	341	* Per device structures are needed because:
	342	* fbops: fb_deferred_io_cleanup() clears fbops.fb_mmap
	343	* fbdefio: individual delays
	344	*/
	345	fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
	346	fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
	347	if (!fbdefio \|\| !fbops) {
	348	kfree(fbdefio);
2a927623	349	kfree(fbops);
199c7717 NT	350	return -ENOMEM;
	351	}
	352
	353	/* can't be offset from vaddr since dirty() uses cma_obj */
	354	fbi->screen_buffer = cma_obj->vaddr;
	355	/* fb_deferred_io_fault() needs a physical address */
	356	fbi->fix.smem_start = page_to_phys(virt_to_page(fbi->screen_buffer));
	357
	358	fbops = fbi->fbops;
	359	fbi->fbops = fbops;
	360
	361	fbdefio->delay = msecs_to_jiffies(DEFAULT_FBDEFIO_DELAY_MS);
	362	fbdefio->deferred_io = drm_fb_helper_deferred_io;
	363	fbi->fbdefio = fbdefio;
	364	fb_deferred_io_init(fbi);
	365	fbi->fbops->fb_mmap = drm_fbdev_cma_deferred_io_mmap;
	366
	367	return 0;
	368	}
	369
	370	static void drm_fbdev_cma_defio_fini(struct fb_info *fbi)
	371	{
	372	if (!fbi->fbdefio)
	373	return;
	374
	375	fb_deferred_io_cleanup(fbi);
	376	kfree(fbi->fbdefio);
	377	kfree(fbi->fbops);
	378	}
	379
	380	/*
	381	* For use in a (struct drm_fb_helper_funcs *)->fb_probe callback function that
	382	* needs custom struct drm_framebuffer_funcs, like dirty() for deferred_io use.
	383	*/
	384	int drm_fbdev_cma_create_with_funcs(struct drm_fb_helper *helper,
	385	struct drm_fb_helper_surface_size *sizes,
fdce1846	386	const struct drm_framebuffer_funcs *funcs)
2e3b3c42 LPC	387	{
	388	struct drm_fbdev_cma *fbdev_cma = to_fbdev_cma(helper);
	389	struct drm_mode_fb_cmd2 mode_cmd = { 0 };
	390	struct drm_device *dev = helper->dev;
	391	struct drm_gem_cma_object *obj;
	392	struct drm_framebuffer *fb;
	393	unsigned int bytes_per_pixel;
	394	unsigned long offset;
	395	struct fb_info *fbi;
	396	size_t size;
	397	int ret;
	398
e0d78d08	399	DRM_DEBUG_KMS("surface width(%d), height(%d) and bpp(%d)\n",
2e3b3c42 LPC	400	sizes->surface_width, sizes->surface_height,
	401	sizes->surface_bpp);
	402
	403	bytes_per_pixel = DIV_ROUND_UP(sizes->surface_bpp, 8);
	404
	405	mode_cmd.width = sizes->surface_width;
	406	mode_cmd.height = sizes->surface_height;
	407	mode_cmd.pitches[0] = sizes->surface_width * bytes_per_pixel;
	408	mode_cmd.pixel_format = drm_mode_legacy_fb_format(sizes->surface_bpp,
	409	sizes->surface_depth);
	410
	411	size = mode_cmd.pitches[0] * mode_cmd.height;
	412	obj = drm_gem_cma_create(dev, size);
02813245	413	if (IS_ERR(obj))
2e3b3c42 LPC	414	return -ENOMEM;
2e3b3c42 LPC	415
85f2edf2 AT	416	fbi = drm_fb_helper_alloc_fbi(helper);
	417	if (IS_ERR(fbi)) {
	418	ret = PTR_ERR(fbi);
50cbc132	419	goto err_gem_free_object;
2e3b3c42 LPC	420	}
2e3b3c42 LPC	421
199c7717	422	fbdev_cma->fb = drm_fb_cma_alloc(dev, &mode_cmd, &obj, 1, funcs);
2e3b3c42 LPC	423	if (IS_ERR(fbdev_cma->fb)) {
	424	dev_err(dev->dev, "Failed to allocate DRM framebuffer.\n");
	425	ret = PTR_ERR(fbdev_cma->fb);
85f2edf2	426	goto err_fb_info_destroy;
2e3b3c42 LPC	427	}
	428
	429	fb = &fbdev_cma->fb->fb;
	430	helper->fb = fb;
2e3b3c42 LPC	431
	432	fbi->par = helper;
	433	fbi->flags = FBINFO_FLAG_DEFAULT;
	434	fbi->fbops = &drm_fbdev_cma_ops;
	435
2e3b3c42	436	drm_fb_helper_fill_fix(fbi, fb->pitches[0], fb->depth);
8d76612b	437	drm_fb_helper_fill_var(fbi, helper, sizes->fb_width, sizes->fb_height);
2e3b3c42 LPC	438
	439	offset = fbi->var.xoffset * bytes_per_pixel;
	440	offset += fbi->var.yoffset * fb->pitches[0];
	441
	442	dev->mode_config.fb_base = (resource_size_t)obj->paddr;
	443	fbi->screen_base = obj->vaddr + offset;
	444	fbi->fix.smem_start = (unsigned long)(obj->paddr + offset);
	445	fbi->screen_size = size;
	446	fbi->fix.smem_len = size;
	447
199c7717 NT	448	if (funcs->dirty) {
	449	ret = drm_fbdev_cma_defio_init(fbi, obj);
	450	if (ret)
	451	goto err_cma_destroy;
	452	}
	453
2e3b3c42 LPC	454	return 0;
2e3b3c42 LPC	455
199c7717 NT	456	err_cma_destroy:
	457	drm_framebuffer_unregister_private(&fbdev_cma->fb->fb);
	458	drm_fb_cma_destroy(&fbdev_cma->fb->fb);
85f2edf2 AT	459	err_fb_info_destroy:
85f2edf2 AT	460	drm_fb_helper_release_fbi(helper);
50cbc132	461	err_gem_free_object:
afe705be	462	drm_gem_object_unreference_unlocked(&obj->base);
2e3b3c42 LPC	463	return ret;
2e3b3c42 LPC	464	}
199c7717 NT	465	EXPORT_SYMBOL(drm_fbdev_cma_create_with_funcs);
	466
	467	static int drm_fbdev_cma_create(struct drm_fb_helper *helper,
	468	struct drm_fb_helper_surface_size *sizes)
	469	{
	470	return drm_fbdev_cma_create_with_funcs(helper, sizes, &drm_fb_cma_funcs);
	471	}
2e3b3c42	472
3a493879	473	static const struct drm_fb_helper_funcs drm_fb_cma_helper_funcs = {
cd5428a5	474	.fb_probe = drm_fbdev_cma_create,
2e3b3c42 LPC	475	};
	476
	477	/**
199c7717	478	* drm_fbdev_cma_init_with_funcs() - Allocate and initializes a drm_fbdev_cma struct
2e3b3c42 LPC	479	* @dev: DRM device
	480	* @preferred_bpp: Preferred bits per pixel for the device
	481	* @num_crtc: Number of CRTCs
	482	* @max_conn_count: Maximum number of connectors
199c7717	483	* @funcs: fb helper functions, in particular fb_probe()
2e3b3c42 LPC	484	*
	485	* Returns a newly allocated drm_fbdev_cma struct or a ERR_PTR.
	486	*/
199c7717	487	struct drm_fbdev_cma drm_fbdev_cma_init_with_funcs(struct drm_device dev,
2e3b3c42	488	unsigned int preferred_bpp, unsigned int num_crtc,
199c7717	489	unsigned int max_conn_count, const struct drm_fb_helper_funcs *funcs)
2e3b3c42 LPC	490	{
	491	struct drm_fbdev_cma *fbdev_cma;
	492	struct drm_fb_helper *helper;
	493	int ret;
	494
	495	fbdev_cma = kzalloc(sizeof(*fbdev_cma), GFP_KERNEL);
	496	if (!fbdev_cma) {
	497	dev_err(dev->dev, "Failed to allocate drm fbdev.\n");
	498	return ERR_PTR(-ENOMEM);
	499	}
	500
2e3b3c42 LPC	501	helper = &fbdev_cma->fb_helper;
2e3b3c42 LPC	502
199c7717	503	drm_fb_helper_prepare(dev, helper, funcs);
10a23102	504
2e3b3c42 LPC	505	ret = drm_fb_helper_init(dev, helper, num_crtc, max_conn_count);
	506	if (ret < 0) {
	507	dev_err(dev->dev, "Failed to initialize drm fb helper.\n");
	508	goto err_free;
	509	}
	510
	511	ret = drm_fb_helper_single_add_all_connectors(helper);
	512	if (ret < 0) {
	513	dev_err(dev->dev, "Failed to add connectors.\n");
	514	goto err_drm_fb_helper_fini;
	515
	516	}
	517
	518	ret = drm_fb_helper_initial_config(helper, preferred_bpp);
	519	if (ret < 0) {
8b513d0c	520	dev_err(dev->dev, "Failed to set initial hw configuration.\n");
2e3b3c42 LPC	521	goto err_drm_fb_helper_fini;
	522	}
	523
	524	return fbdev_cma;
	525
	526	err_drm_fb_helper_fini:
	527	drm_fb_helper_fini(helper);
	528	err_free:
	529	kfree(fbdev_cma);
	530
	531	return ERR_PTR(ret);
	532	}
199c7717 NT	533	EXPORT_SYMBOL_GPL(drm_fbdev_cma_init_with_funcs);
	534
	535	/**
	536	* drm_fbdev_cma_init() - Allocate and initializes a drm_fbdev_cma struct
	537	* @dev: DRM device
	538	* @preferred_bpp: Preferred bits per pixel for the device
	539	* @num_crtc: Number of CRTCs
	540	* @max_conn_count: Maximum number of connectors
	541	*
	542	* Returns a newly allocated drm_fbdev_cma struct or a ERR_PTR.
	543	*/
	544	struct drm_fbdev_cma drm_fbdev_cma_init(struct drm_device dev,
	545	unsigned int preferred_bpp, unsigned int num_crtc,
	546	unsigned int max_conn_count)
	547	{
	548	return drm_fbdev_cma_init_with_funcs(dev, preferred_bpp, num_crtc,
	549	max_conn_count, &drm_fb_cma_helper_funcs);
	550	}
2e3b3c42 LPC	551	EXPORT_SYMBOL_GPL(drm_fbdev_cma_init);
	552
	553	/**
	554	* drm_fbdev_cma_fini() - Free drm_fbdev_cma struct
	555	* @fbdev_cma: The drm_fbdev_cma struct
	556	*/
	557	void drm_fbdev_cma_fini(struct drm_fbdev_cma *fbdev_cma)
	558	{
85f2edf2	559	drm_fb_helper_unregister_fbi(&fbdev_cma->fb_helper);
199c7717	560	drm_fbdev_cma_defio_fini(fbdev_cma->fb_helper.fbdev);
85f2edf2	561	drm_fb_helper_release_fbi(&fbdev_cma->fb_helper);
2e3b3c42	562
36206361 DV	563	if (fbdev_cma->fb) {
36206361 DV	564	drm_framebuffer_unregister_private(&fbdev_cma->fb->fb);
2e3b3c42	565	drm_fb_cma_destroy(&fbdev_cma->fb->fb);
36206361	566	}
2e3b3c42 LPC	567
	568	drm_fb_helper_fini(&fbdev_cma->fb_helper);
	569	kfree(fbdev_cma);
	570	}
	571	EXPORT_SYMBOL_GPL(drm_fbdev_cma_fini);
	572
	573	/**
	574	* drm_fbdev_cma_restore_mode() - Restores initial framebuffer mode
	575	* @fbdev_cma: The drm_fbdev_cma struct, may be NULL
	576	*
	577	* This function is usually called from the DRM drivers lastclose callback.
	578	*/
	579	void drm_fbdev_cma_restore_mode(struct drm_fbdev_cma *fbdev_cma)
	580	{
5ea1f752 RC	581	if (fbdev_cma)
5ea1f752 RC	582	drm_fb_helper_restore_fbdev_mode_unlocked(&fbdev_cma->fb_helper);
2e3b3c42 LPC	583	}
	584	EXPORT_SYMBOL_GPL(drm_fbdev_cma_restore_mode);
	585
	586	/**
	587	* drm_fbdev_cma_hotplug_event() - Poll for hotpulug events
	588	* @fbdev_cma: The drm_fbdev_cma struct, may be NULL
	589	*
	590	* This function is usually called from the DRM drivers output_poll_changed
	591	* callback.
	592	*/
	593	void drm_fbdev_cma_hotplug_event(struct drm_fbdev_cma *fbdev_cma)
	594	{
	595	if (fbdev_cma)
	596	drm_fb_helper_hotplug_event(&fbdev_cma->fb_helper);
	597	}
	598	EXPORT_SYMBOL_GPL(drm_fbdev_cma_hotplug_event);
917f4253 SA	599
	600	/**
	601	* drm_fbdev_cma_set_suspend - wrapper around drm_fb_helper_set_suspend
	602	* @fbdev_cma: The drm_fbdev_cma struct, may be NULL
	603	* @state: desired state, zero to resume, non-zero to suspend
	604	*
	605	* Calls drm_fb_helper_set_suspend, which is a wrapper around
	606	* fb_set_suspend implemented by fbdev core.
	607	*/
	608	void drm_fbdev_cma_set_suspend(struct drm_fbdev_cma *fbdev_cma, int state)
	609	{
	610	if (fbdev_cma)
	611	drm_fb_helper_set_suspend(&fbdev_cma->fb_helper, state);
	612	}
	613	EXPORT_SYMBOL(drm_fbdev_cma_set_suspend);