root/sys/dev/drm2/drm_crtc.c
/*
 * Copyright (c) 2006-2008 Intel Corporation
 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
 * Copyright (c) 2008 Red Hat Inc.
 *
 * DRM core CRTC related 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:
 *      Keith Packard
 *      Eric Anholt <eric@anholt.net>
 *      Dave Airlie <airlied@linux.ie>
 *      Jesse Barnes <jesse.barnes@intel.com>
 */
#include <sys/cdefs.h>
#include <dev/drm2/drmP.h>
#include <dev/drm2/drm_crtc.h>
#include <dev/drm2/drm_edid.h>
#include <dev/drm2/drm_fourcc.h>

static void drm_property_destroy_blob(struct drm_device *dev,
    struct drm_property_blob *blob);

/* Avoid boilerplate.  I'm tired of typing. */
#define DRM_ENUM_NAME_FN(fnname, list)                          \
        char *fnname(int val)                                   \
        {                                                       \
                int i;                                          \
                for (i = 0; i < ARRAY_SIZE(list); i++) {        \
                        if (list[i].type == val)                \
                                return list[i].name;            \
                }                                               \
                return "(unknown)";                             \
        }

/*
 * Global properties
 */
static struct drm_prop_enum_list drm_dpms_enum_list[] =
{       { DRM_MODE_DPMS_ON, "On" },
        { DRM_MODE_DPMS_STANDBY, "Standby" },
        { DRM_MODE_DPMS_SUSPEND, "Suspend" },
        { DRM_MODE_DPMS_OFF, "Off" }
};

DRM_ENUM_NAME_FN(drm_get_dpms_name, drm_dpms_enum_list)

/*
 * Optional properties
 */
static struct drm_prop_enum_list drm_scaling_mode_enum_list[] =
{
        { DRM_MODE_SCALE_NONE, "None" },
        { DRM_MODE_SCALE_FULLSCREEN, "Full" },
        { DRM_MODE_SCALE_CENTER, "Center" },
        { DRM_MODE_SCALE_ASPECT, "Full aspect" },
};

static struct drm_prop_enum_list drm_dithering_mode_enum_list[] =
{
        { DRM_MODE_DITHERING_OFF, "Off" },
        { DRM_MODE_DITHERING_ON, "On" },
        { DRM_MODE_DITHERING_AUTO, "Automatic" },
};

/*
 * Non-global properties, but "required" for certain connectors.
 */
static struct drm_prop_enum_list drm_dvi_i_select_enum_list[] =
{
        { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
        { DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
        { DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
};

DRM_ENUM_NAME_FN(drm_get_dvi_i_select_name, drm_dvi_i_select_enum_list)

static struct drm_prop_enum_list drm_dvi_i_subconnector_enum_list[] =
{
        { DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
        { DRM_MODE_SUBCONNECTOR_DVID,      "DVI-D"     }, /* DVI-I  */
        { DRM_MODE_SUBCONNECTOR_DVIA,      "DVI-A"     }, /* DVI-I  */
};

DRM_ENUM_NAME_FN(drm_get_dvi_i_subconnector_name,
                 drm_dvi_i_subconnector_enum_list)

static struct drm_prop_enum_list drm_tv_select_enum_list[] =
{
        { DRM_MODE_SUBCONNECTOR_Automatic, "Automatic" }, /* DVI-I and TV-out */
        { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
        { DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
        { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
        { DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
};

DRM_ENUM_NAME_FN(drm_get_tv_select_name, drm_tv_select_enum_list)

static struct drm_prop_enum_list drm_tv_subconnector_enum_list[] =
{
        { DRM_MODE_SUBCONNECTOR_Unknown,   "Unknown"   }, /* DVI-I and TV-out */
        { DRM_MODE_SUBCONNECTOR_Composite, "Composite" }, /* TV-out */
        { DRM_MODE_SUBCONNECTOR_SVIDEO,    "SVIDEO"    }, /* TV-out */
        { DRM_MODE_SUBCONNECTOR_Component, "Component" }, /* TV-out */
        { DRM_MODE_SUBCONNECTOR_SCART,     "SCART"     }, /* TV-out */
};

DRM_ENUM_NAME_FN(drm_get_tv_subconnector_name,
                 drm_tv_subconnector_enum_list)

static struct drm_prop_enum_list drm_dirty_info_enum_list[] = {
        { DRM_MODE_DIRTY_OFF,      "Off"      },
        { DRM_MODE_DIRTY_ON,       "On"       },
        { DRM_MODE_DIRTY_ANNOTATE, "Annotate" },
};

DRM_ENUM_NAME_FN(drm_get_dirty_info_name,
                 drm_dirty_info_enum_list)

struct drm_conn_prop_enum_list {
        int type;
        char *name;
        int count;
};

/*
 * Connector and encoder types.
 */
static struct drm_conn_prop_enum_list drm_connector_enum_list[] =
{       { DRM_MODE_CONNECTOR_Unknown, "Unknown", 0 },
        { DRM_MODE_CONNECTOR_VGA, "VGA", 0 },
        { DRM_MODE_CONNECTOR_DVII, "DVI-I", 0 },
        { DRM_MODE_CONNECTOR_DVID, "DVI-D", 0 },
        { DRM_MODE_CONNECTOR_DVIA, "DVI-A", 0 },
        { DRM_MODE_CONNECTOR_Composite, "Composite", 0 },
        { DRM_MODE_CONNECTOR_SVIDEO, "SVIDEO", 0 },
        { DRM_MODE_CONNECTOR_LVDS, "LVDS", 0 },
        { DRM_MODE_CONNECTOR_Component, "Component", 0 },
        { DRM_MODE_CONNECTOR_9PinDIN, "DIN", 0 },
        { DRM_MODE_CONNECTOR_DisplayPort, "DP", 0 },
        { DRM_MODE_CONNECTOR_HDMIA, "HDMI-A", 0 },
        { DRM_MODE_CONNECTOR_HDMIB, "HDMI-B", 0 },
        { DRM_MODE_CONNECTOR_TV, "TV", 0 },
        { DRM_MODE_CONNECTOR_eDP, "eDP", 0 },
        { DRM_MODE_CONNECTOR_VIRTUAL, "Virtual", 0},
};

static struct drm_prop_enum_list drm_encoder_enum_list[] =
{       { DRM_MODE_ENCODER_NONE, "None" },
        { DRM_MODE_ENCODER_DAC, "DAC" },
        { DRM_MODE_ENCODER_TMDS, "TMDS" },
        { DRM_MODE_ENCODER_LVDS, "LVDS" },
        { DRM_MODE_ENCODER_TVDAC, "TV" },
        { DRM_MODE_ENCODER_VIRTUAL, "Virtual" },
};

char *drm_get_encoder_name(struct drm_encoder *encoder)
{
        static char buf[32];

        snprintf(buf, 32, "%s-%d",
                 drm_encoder_enum_list[encoder->encoder_type].name,
                 encoder->base.id);
        return buf;
}
EXPORT_SYMBOL(drm_get_encoder_name);

char *drm_get_connector_name(struct drm_connector *connector)
{
        static char buf[32];

        snprintf(buf, 32, "%s-%d",
                 drm_connector_enum_list[connector->connector_type].name,
                 connector->connector_type_id);
        return buf;
}
EXPORT_SYMBOL(drm_get_connector_name);

char *drm_get_connector_status_name(enum drm_connector_status status)
{
        if (status == connector_status_connected)
                return "connected";
        else if (status == connector_status_disconnected)
                return "disconnected";
        else
                return "unknown";
}

/**
 * drm_mode_object_get - allocate a new identifier
 * @dev: DRM device
 * @ptr: object pointer, used to generate unique ID
 * @type: object type
 *
 * LOCKING:
 *
 * Create a unique identifier based on @ptr in @dev's identifier space.  Used
 * for tracking modes, CRTCs and connectors.
 *
 * RETURNS:
 * New unique (relative to other objects in @dev) integer identifier for the
 * object.
 */
static int drm_mode_object_get(struct drm_device *dev,
                               struct drm_mode_object *obj, uint32_t obj_type)
{
        int new_id = 0;
        int ret;

        ret = drm_gem_name_create(&dev->mode_config.crtc_names, obj, &new_id);
        if (ret)
                return ret;

        obj->id = new_id;
        obj->type = obj_type;
        return 0;
}

/**
 * drm_mode_object_put - free an identifer
 * @dev: DRM device
 * @id: ID to free
 *
 * LOCKING:
 * Caller must hold DRM mode_config lock.
 *
 * Free @id from @dev's unique identifier pool.
 */
static void drm_mode_object_put(struct drm_device *dev,
                                struct drm_mode_object *object)
{

        drm_gem_names_remove(&dev->mode_config.crtc_names, object->id);
}

struct drm_mode_object *drm_mode_object_find(struct drm_device *dev,
                uint32_t id, uint32_t type)
{
        struct drm_mode_object *obj = NULL;

        obj = drm_gem_name_ref(&dev->mode_config.crtc_names, id, NULL);
        if (!obj || (obj->type != type) || (obj->id != id))
                obj = NULL;

        return obj;
}
EXPORT_SYMBOL(drm_mode_object_find);

/**
 * drm_framebuffer_init - initialize a framebuffer
 * @dev: DRM device
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Allocates an ID for the framebuffer's parent mode object, sets its mode
 * functions & device file and adds it to the master fd list.
 *
 * RETURNS:
 * Zero on success, error code on failure.
 */
int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb,
                         const struct drm_framebuffer_funcs *funcs)
{
        int ret;

        refcount_init(&fb->refcount, 1);

        ret = drm_mode_object_get(dev, &fb->base, DRM_MODE_OBJECT_FB);
        if (ret)
                return ret;

        fb->dev = dev;
        fb->funcs = funcs;
        dev->mode_config.num_fb++;
        list_add(&fb->head, &dev->mode_config.fb_list);

        return 0;
}
EXPORT_SYMBOL(drm_framebuffer_init);

static void drm_framebuffer_free(struct drm_framebuffer *fb)
{
        fb->funcs->destroy(fb);
}

/**
 * drm_framebuffer_unreference - unref a framebuffer
 *
 * LOCKING:
 * Caller must hold mode config lock.
 */
void drm_framebuffer_unreference(struct drm_framebuffer *fb)
{
        struct drm_device *dev = fb->dev;
        DRM_DEBUG("FB ID: %d\n", fb->base.id);
        if (!sx_xlocked(&dev->mode_config.mutex))
                DRM_WARNING("%s: dev->mode_config.mutex not locked\n", __func__);
        if (refcount_release(&fb->refcount))
                drm_framebuffer_free(fb);
}
EXPORT_SYMBOL(drm_framebuffer_unreference);

/**
 * drm_framebuffer_reference - incr the fb refcnt
 */
void drm_framebuffer_reference(struct drm_framebuffer *fb)
{
        DRM_DEBUG("FB ID: %d\n", fb->base.id);
        refcount_acquire(&fb->refcount);
}
EXPORT_SYMBOL(drm_framebuffer_reference);

/**
 * drm_framebuffer_cleanup - remove a framebuffer object
 * @fb: framebuffer to remove
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Scans all the CRTCs in @dev's mode_config.  If they're using @fb, removes
 * it, setting it to NULL.
 */
void drm_framebuffer_cleanup(struct drm_framebuffer *fb)
{
        struct drm_device *dev = fb->dev;
        /*
         * This could be moved to drm_framebuffer_remove(), but for
         * debugging is nice to keep around the list of fb's that are
         * no longer associated w/ a drm_file but are not unreferenced
         * yet.  (i915 and omapdrm have debugfs files which will show
         * this.)
         */
        drm_mode_object_put(dev, &fb->base);
        list_del(&fb->head);
        dev->mode_config.num_fb--;
}
EXPORT_SYMBOL(drm_framebuffer_cleanup);

/**
 * drm_framebuffer_remove - remove and unreference a framebuffer object
 * @fb: framebuffer to remove
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Scans all the CRTCs and planes in @dev's mode_config.  If they're
 * using @fb, removes it, setting it to NULL.
 */
void drm_framebuffer_remove(struct drm_framebuffer *fb)
{
        struct drm_device *dev = fb->dev;
        struct drm_crtc *crtc;
        struct drm_plane *plane;
        struct drm_mode_set set;
        int ret;

        /* remove from any CRTC */
        list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
                if (crtc->fb == fb) {
                        /* should turn off the crtc */
                        memset(&set, 0, sizeof(struct drm_mode_set));
                        set.crtc = crtc;
                        set.fb = NULL;
                        ret = crtc->funcs->set_config(&set);
                        if (ret)
                                DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc);
                }
        }

        list_for_each_entry(plane, &dev->mode_config.plane_list, head) {
                if (plane->fb == fb) {
                        /* should turn off the crtc */
                        ret = plane->funcs->disable_plane(plane);
                        if (ret)
                                DRM_ERROR("failed to disable plane with busy fb\n");
                        /* disconnect the plane from the fb and crtc: */
                        plane->fb = NULL;
                        plane->crtc = NULL;
                }
        }

        list_del(&fb->filp_head);

        drm_framebuffer_unreference(fb);
}
EXPORT_SYMBOL(drm_framebuffer_remove);

/**
 * drm_crtc_init - Initialise a new CRTC object
 * @dev: DRM device
 * @crtc: CRTC object to init
 * @funcs: callbacks for the new CRTC
 *
 * LOCKING:
 * Takes mode_config lock.
 *
 * Inits a new object created as base part of an driver crtc object.
 *
 * RETURNS:
 * Zero on success, error code on failure.
 */
int drm_crtc_init(struct drm_device *dev, struct drm_crtc *crtc,
                   const struct drm_crtc_funcs *funcs)
{
        int ret;

        crtc->dev = dev;
        crtc->funcs = funcs;
        crtc->invert_dimensions = false;

        sx_xlock(&dev->mode_config.mutex);

        ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
        if (ret)
                goto out;

        crtc->base.properties = &crtc->properties;

        list_add_tail(&crtc->head, &dev->mode_config.crtc_list);
        dev->mode_config.num_crtc++;

 out:
        sx_xunlock(&dev->mode_config.mutex);

        return ret;
}
EXPORT_SYMBOL(drm_crtc_init);

/**
 * drm_crtc_cleanup - Cleans up the core crtc usage.
 * @crtc: CRTC to cleanup
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Cleanup @crtc. Removes from drm modesetting space
 * does NOT free object, caller does that.
 */
void drm_crtc_cleanup(struct drm_crtc *crtc)
{
        struct drm_device *dev = crtc->dev;

        free(crtc->gamma_store, DRM_MEM_KMS);
        crtc->gamma_store = NULL;

        drm_mode_object_put(dev, &crtc->base);
        list_del(&crtc->head);
        dev->mode_config.num_crtc--;
}
EXPORT_SYMBOL(drm_crtc_cleanup);

/**
 * drm_mode_probed_add - add a mode to a connector's probed mode list
 * @connector: connector the new mode
 * @mode: mode data
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Add @mode to @connector's mode list for later use.
 */
void drm_mode_probed_add(struct drm_connector *connector,
                         struct drm_display_mode *mode)
{
        list_add(&mode->head, &connector->probed_modes);
}
EXPORT_SYMBOL(drm_mode_probed_add);

/**
 * drm_mode_remove - remove and free a mode
 * @connector: connector list to modify
 * @mode: mode to remove
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Remove @mode from @connector's mode list, then free it.
 */
void drm_mode_remove(struct drm_connector *connector,
                     struct drm_display_mode *mode)
{
        list_del(&mode->head);
        drm_mode_destroy(connector->dev, mode);
}
EXPORT_SYMBOL(drm_mode_remove);

/**
 * drm_connector_init - Init a preallocated connector
 * @dev: DRM device
 * @connector: the connector to init
 * @funcs: callbacks for this connector
 * @name: user visible name of the connector
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Initialises a preallocated connector. Connectors should be
 * subclassed as part of driver connector objects.
 *
 * RETURNS:
 * Zero on success, error code on failure.
 */
int drm_connector_init(struct drm_device *dev,
                       struct drm_connector *connector,
                       const struct drm_connector_funcs *funcs,
                       int connector_type)
{
        int ret;

        sx_xlock(&dev->mode_config.mutex);

        ret = drm_mode_object_get(dev, &connector->base, DRM_MODE_OBJECT_CONNECTOR);
        if (ret)
                goto out;

        connector->base.properties = &connector->properties;
        connector->dev = dev;
        connector->funcs = funcs;
        connector->connector_type = connector_type;
        connector->connector_type_id =
                ++drm_connector_enum_list[connector_type].count; /* TODO */
        INIT_LIST_HEAD(&connector->user_modes);
        INIT_LIST_HEAD(&connector->probed_modes);
        INIT_LIST_HEAD(&connector->modes);
        connector->edid_blob_ptr = NULL;
        connector->status = connector_status_unknown;

        list_add_tail(&connector->head, &dev->mode_config.connector_list);
        dev->mode_config.num_connector++;

        if (connector_type != DRM_MODE_CONNECTOR_VIRTUAL)
                drm_object_attach_property(&connector->base,
                                              dev->mode_config.edid_property,
                                              0);

        drm_object_attach_property(&connector->base,
                                      dev->mode_config.dpms_property, 0);

 out:
        sx_xunlock(&dev->mode_config.mutex);

        return ret;
}
EXPORT_SYMBOL(drm_connector_init);

/**
 * drm_connector_cleanup - cleans up an initialised connector
 * @connector: connector to cleanup
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Cleans up the connector but doesn't free the object.
 */
void drm_connector_cleanup(struct drm_connector *connector)
{
        struct drm_device *dev = connector->dev;
        struct drm_display_mode *mode, *t;

        list_for_each_entry_safe(mode, t, &connector->probed_modes, head)
                drm_mode_remove(connector, mode);

        list_for_each_entry_safe(mode, t, &connector->modes, head)
                drm_mode_remove(connector, mode);

        list_for_each_entry_safe(mode, t, &connector->user_modes, head)
                drm_mode_remove(connector, mode);

        sx_xlock(&dev->mode_config.mutex);
        drm_mode_object_put(dev, &connector->base);
        list_del(&connector->head);
        dev->mode_config.num_connector--;
        sx_xunlock(&dev->mode_config.mutex);
}
EXPORT_SYMBOL(drm_connector_cleanup);

void drm_connector_unplug_all(struct drm_device *dev)
{
#ifdef FREEBSD_NOTYET
        struct drm_connector *connector;

        /* taking the mode config mutex ends up in a clash with sysfs */
        list_for_each_entry(connector, &dev->mode_config.connector_list, head)
                drm_sysfs_connector_remove(connector);
#endif /* FREEBSD_NOTYET */

}
EXPORT_SYMBOL(drm_connector_unplug_all);

int drm_encoder_init(struct drm_device *dev,
                      struct drm_encoder *encoder,
                      const struct drm_encoder_funcs *funcs,
                      int encoder_type)
{
        int ret;

        sx_xlock(&dev->mode_config.mutex);

        ret = drm_mode_object_get(dev, &encoder->base, DRM_MODE_OBJECT_ENCODER);
        if (ret)
                goto out;

        encoder->dev = dev;
        encoder->encoder_type = encoder_type;
        encoder->funcs = funcs;

        list_add_tail(&encoder->head, &dev->mode_config.encoder_list);
        dev->mode_config.num_encoder++;

 out:
        sx_xunlock(&dev->mode_config.mutex);

        return ret;
}
EXPORT_SYMBOL(drm_encoder_init);

void drm_encoder_cleanup(struct drm_encoder *encoder)
{
        struct drm_device *dev = encoder->dev;
        sx_xlock(&dev->mode_config.mutex);
        drm_mode_object_put(dev, &encoder->base);
        list_del(&encoder->head);
        dev->mode_config.num_encoder--;
        sx_xunlock(&dev->mode_config.mutex);
}
EXPORT_SYMBOL(drm_encoder_cleanup);

int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
                   unsigned long possible_crtcs,
                   const struct drm_plane_funcs *funcs,
                   const uint32_t *formats, uint32_t format_count,
                   bool priv)
{
        int ret;

        sx_xlock(&dev->mode_config.mutex);

        ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
        if (ret)
                goto out;

        plane->base.properties = &plane->properties;
        plane->dev = dev;
        plane->funcs = funcs;
        plane->format_types = malloc(sizeof(uint32_t) * format_count,
            DRM_MEM_KMS, M_WAITOK);
        memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
        plane->format_count = format_count;
        plane->possible_crtcs = possible_crtcs;

        /* private planes are not exposed to userspace, but depending on
         * display hardware, might be convenient to allow sharing programming
         * for the scanout engine with the crtc implementation.
         */
        if (!priv) {
                list_add_tail(&plane->head, &dev->mode_config.plane_list);
                dev->mode_config.num_plane++;
        } else {
                INIT_LIST_HEAD(&plane->head);
        }

 out:
        sx_xunlock(&dev->mode_config.mutex);

        return ret;
}
EXPORT_SYMBOL(drm_plane_init);

void drm_plane_cleanup(struct drm_plane *plane)
{
        struct drm_device *dev = plane->dev;

        sx_xlock(&dev->mode_config.mutex);
        free(plane->format_types, DRM_MEM_KMS);
        drm_mode_object_put(dev, &plane->base);
        /* if not added to a list, it must be a private plane */
        if (!list_empty(&plane->head)) {
                list_del(&plane->head);
                dev->mode_config.num_plane--;
        }
        sx_xunlock(&dev->mode_config.mutex);
}
EXPORT_SYMBOL(drm_plane_cleanup);

/**
 * drm_mode_create - create a new display mode
 * @dev: DRM device
 *
 * LOCKING:
 * Caller must hold DRM mode_config lock.
 *
 * Create a new drm_display_mode, give it an ID, and return it.
 *
 * RETURNS:
 * Pointer to new mode on success, NULL on error.
 */
struct drm_display_mode *drm_mode_create(struct drm_device *dev)
{
        struct drm_display_mode *nmode;

        nmode = malloc(sizeof(struct drm_display_mode), DRM_MEM_KMS,
            M_WAITOK | M_ZERO);

        if (drm_mode_object_get(dev, &nmode->base, DRM_MODE_OBJECT_MODE)) {
                free(nmode, DRM_MEM_KMS);
                return NULL;
        }

        return nmode;
}
EXPORT_SYMBOL(drm_mode_create);

/**
 * drm_mode_destroy - remove a mode
 * @dev: DRM device
 * @mode: mode to remove
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Free @mode's unique identifier, then free it.
 */
void drm_mode_destroy(struct drm_device *dev, struct drm_display_mode *mode)
{
        if (!mode)
                return;

        drm_mode_object_put(dev, &mode->base);

        free(mode, DRM_MEM_KMS);
}
EXPORT_SYMBOL(drm_mode_destroy);

static int drm_mode_create_standard_connector_properties(struct drm_device *dev)
{
        struct drm_property *edid;
        struct drm_property *dpms;

        /*
         * Standard properties (apply to all connectors)
         */
        edid = drm_property_create(dev, DRM_MODE_PROP_BLOB |
                                   DRM_MODE_PROP_IMMUTABLE,
                                   "EDID", 0);
        dev->mode_config.edid_property = edid;

        dpms = drm_property_create_enum(dev, 0,
                                   "DPMS", drm_dpms_enum_list,
                                   ARRAY_SIZE(drm_dpms_enum_list));
        dev->mode_config.dpms_property = dpms;

        return 0;
}

/**
 * drm_mode_create_dvi_i_properties - create DVI-I specific connector properties
 * @dev: DRM device
 *
 * Called by a driver the first time a DVI-I connector is made.
 */
int drm_mode_create_dvi_i_properties(struct drm_device *dev)
{
        struct drm_property *dvi_i_selector;
        struct drm_property *dvi_i_subconnector;

        if (dev->mode_config.dvi_i_select_subconnector_property)
                return 0;

        dvi_i_selector =
                drm_property_create_enum(dev, 0,
                                    "select subconnector",
                                    drm_dvi_i_select_enum_list,
                                    ARRAY_SIZE(drm_dvi_i_select_enum_list));
        dev->mode_config.dvi_i_select_subconnector_property = dvi_i_selector;

        dvi_i_subconnector = drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
                                    "subconnector",
                                    drm_dvi_i_subconnector_enum_list,
                                    ARRAY_SIZE(drm_dvi_i_subconnector_enum_list));
        dev->mode_config.dvi_i_subconnector_property = dvi_i_subconnector;

        return 0;
}
EXPORT_SYMBOL(drm_mode_create_dvi_i_properties);

/**
 * drm_create_tv_properties - create TV specific connector properties
 * @dev: DRM device
 * @num_modes: number of different TV formats (modes) supported
 * @modes: array of pointers to strings containing name of each format
 *
 * Called by a driver's TV initialization routine, this function creates
 * the TV specific connector properties for a given device.  Caller is
 * responsible for allocating a list of format names and passing them to
 * this routine.
 */
int drm_mode_create_tv_properties(struct drm_device *dev, int num_modes,
                                  char *modes[])
{
        struct drm_property *tv_selector;
        struct drm_property *tv_subconnector;
        int i;

        if (dev->mode_config.tv_select_subconnector_property)
                return 0;

        /*
         * Basic connector properties
         */
        tv_selector = drm_property_create_enum(dev, 0,
                                          "select subconnector",
                                          drm_tv_select_enum_list,
                                          ARRAY_SIZE(drm_tv_select_enum_list));
        dev->mode_config.tv_select_subconnector_property = tv_selector;

        tv_subconnector =
                drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
                                    "subconnector",
                                    drm_tv_subconnector_enum_list,
                                    ARRAY_SIZE(drm_tv_subconnector_enum_list));
        dev->mode_config.tv_subconnector_property = tv_subconnector;

        /*
         * Other, TV specific properties: margins & TV modes.
         */
        dev->mode_config.tv_left_margin_property =
                drm_property_create_range(dev, 0, "left margin", 0, 100);

        dev->mode_config.tv_right_margin_property =
                drm_property_create_range(dev, 0, "right margin", 0, 100);

        dev->mode_config.tv_top_margin_property =
                drm_property_create_range(dev, 0, "top margin", 0, 100);

        dev->mode_config.tv_bottom_margin_property =
                drm_property_create_range(dev, 0, "bottom margin", 0, 100);

        dev->mode_config.tv_mode_property =
                drm_property_create(dev, DRM_MODE_PROP_ENUM,
                                    "mode", num_modes);
        for (i = 0; i < num_modes; i++)
                drm_property_add_enum(dev->mode_config.tv_mode_property, i,
                                      i, modes[i]);

        dev->mode_config.tv_brightness_property =
                drm_property_create_range(dev, 0, "brightness", 0, 100);

        dev->mode_config.tv_contrast_property =
                drm_property_create_range(dev, 0, "contrast", 0, 100);

        dev->mode_config.tv_flicker_reduction_property =
                drm_property_create_range(dev, 0, "flicker reduction", 0, 100);

        dev->mode_config.tv_overscan_property =
                drm_property_create_range(dev, 0, "overscan", 0, 100);

        dev->mode_config.tv_saturation_property =
                drm_property_create_range(dev, 0, "saturation", 0, 100);

        dev->mode_config.tv_hue_property =
                drm_property_create_range(dev, 0, "hue", 0, 100);

        return 0;
}
EXPORT_SYMBOL(drm_mode_create_tv_properties);

/**
 * drm_mode_create_scaling_mode_property - create scaling mode property
 * @dev: DRM device
 *
 * Called by a driver the first time it's needed, must be attached to desired
 * connectors.
 */
int drm_mode_create_scaling_mode_property(struct drm_device *dev)
{
        struct drm_property *scaling_mode;

        if (dev->mode_config.scaling_mode_property)
                return 0;

        scaling_mode =
                drm_property_create_enum(dev, 0, "scaling mode",
                                drm_scaling_mode_enum_list,
                                    ARRAY_SIZE(drm_scaling_mode_enum_list));

        dev->mode_config.scaling_mode_property = scaling_mode;

        return 0;
}
EXPORT_SYMBOL(drm_mode_create_scaling_mode_property);

/**
 * drm_mode_create_dithering_property - create dithering property
 * @dev: DRM device
 *
 * Called by a driver the first time it's needed, must be attached to desired
 * connectors.
 */
int drm_mode_create_dithering_property(struct drm_device *dev)
{
        struct drm_property *dithering_mode;

        if (dev->mode_config.dithering_mode_property)
                return 0;

        dithering_mode =
                drm_property_create_enum(dev, 0, "dithering",
                                drm_dithering_mode_enum_list,
                                    ARRAY_SIZE(drm_dithering_mode_enum_list));
        dev->mode_config.dithering_mode_property = dithering_mode;

        return 0;
}
EXPORT_SYMBOL(drm_mode_create_dithering_property);

/**
 * drm_mode_create_dirty_property - create dirty property
 * @dev: DRM device
 *
 * Called by a driver the first time it's needed, must be attached to desired
 * connectors.
 */
int drm_mode_create_dirty_info_property(struct drm_device *dev)
{
        struct drm_property *dirty_info;

        if (dev->mode_config.dirty_info_property)
                return 0;

        dirty_info =
                drm_property_create_enum(dev, DRM_MODE_PROP_IMMUTABLE,
                                    "dirty",
                                    drm_dirty_info_enum_list,
                                    ARRAY_SIZE(drm_dirty_info_enum_list));
        dev->mode_config.dirty_info_property = dirty_info;

        return 0;
}
EXPORT_SYMBOL(drm_mode_create_dirty_info_property);

/**
 * drm_mode_config_init - initialize DRM mode_configuration structure
 * @dev: DRM device
 *
 * LOCKING:
 * None, should happen single threaded at init time.
 *
 * Initialize @dev's mode_config structure, used for tracking the graphics
 * configuration of @dev.
 */
void drm_mode_config_init(struct drm_device *dev)
{
        sx_init(&dev->mode_config.mutex, "kmslk");
        INIT_LIST_HEAD(&dev->mode_config.fb_list);
        INIT_LIST_HEAD(&dev->mode_config.crtc_list);
        INIT_LIST_HEAD(&dev->mode_config.connector_list);
        INIT_LIST_HEAD(&dev->mode_config.encoder_list);
        INIT_LIST_HEAD(&dev->mode_config.property_list);
        INIT_LIST_HEAD(&dev->mode_config.property_blob_list);
        INIT_LIST_HEAD(&dev->mode_config.plane_list);
        drm_gem_names_init(&dev->mode_config.crtc_names);

        sx_xlock(&dev->mode_config.mutex);
        drm_mode_create_standard_connector_properties(dev);
        sx_xunlock(&dev->mode_config.mutex);

        /* Just to be sure */
        dev->mode_config.num_fb = 0;
        dev->mode_config.num_connector = 0;
        dev->mode_config.num_crtc = 0;
        dev->mode_config.num_encoder = 0;
}
EXPORT_SYMBOL(drm_mode_config_init);

int drm_mode_group_init(struct drm_device *dev, struct drm_mode_group *group)
{
        uint32_t total_objects = 0;

        total_objects += dev->mode_config.num_crtc;
        total_objects += dev->mode_config.num_connector;
        total_objects += dev->mode_config.num_encoder;

        group->id_list = malloc(total_objects * sizeof(uint32_t),
            DRM_MEM_KMS, M_WAITOK | M_ZERO);
        group->num_crtcs = 0;
        group->num_connectors = 0;
        group->num_encoders = 0;
        return 0;
}

void drm_mode_group_free(struct drm_mode_group *group)
{
        free(group->id_list, DRM_MEM_KMS);
        group->id_list = NULL;
}

int drm_mode_group_init_legacy_group(struct drm_device *dev,
                                     struct drm_mode_group *group)
{
        struct drm_crtc *crtc;
        struct drm_encoder *encoder;
        struct drm_connector *connector;
        int ret;

        if ((ret = drm_mode_group_init(dev, group)))
                return ret;

        list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
                group->id_list[group->num_crtcs++] = crtc->base.id;

        list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
                group->id_list[group->num_crtcs + group->num_encoders++] =
                encoder->base.id;

        list_for_each_entry(connector, &dev->mode_config.connector_list, head)
                group->id_list[group->num_crtcs + group->num_encoders +
                               group->num_connectors++] = connector->base.id;

        return 0;
}
EXPORT_SYMBOL(drm_mode_group_init_legacy_group);

/**
 * drm_mode_config_cleanup - free up DRM mode_config info
 * @dev: DRM device
 *
 * LOCKING:
 * Caller must hold mode config lock.
 *
 * Free up all the connectors and CRTCs associated with this DRM device, then
 * free up the framebuffers and associated buffer objects.
 *
 * FIXME: cleanup any dangling user buffer objects too
 */
void drm_mode_config_cleanup(struct drm_device *dev)
{
        struct drm_connector *connector, *ot;
        struct drm_crtc *crtc, *ct;
        struct drm_encoder *encoder, *enct;
        struct drm_framebuffer *fb, *fbt;
        struct drm_property *property, *pt;
        struct drm_property_blob *blob, *bt;
        struct drm_plane *plane, *plt;

        list_for_each_entry_safe(encoder, enct, &dev->mode_config.encoder_list,
                                 head) {
                encoder->funcs->destroy(encoder);
        }

        list_for_each_entry_safe(connector, ot,
                                 &dev->mode_config.connector_list, head) {
                connector->funcs->destroy(connector);
        }

        list_for_each_entry_safe(property, pt, &dev->mode_config.property_list,
                                 head) {
                drm_property_destroy(dev, property);
        }

        list_for_each_entry_safe(blob, bt, &dev->mode_config.property_blob_list,
                                 head) {
                drm_property_destroy_blob(dev, blob);
        }

        list_for_each_entry_safe(fb, fbt, &dev->mode_config.fb_list, head) {
                drm_framebuffer_remove(fb);
        }

        list_for_each_entry_safe(plane, plt, &dev->mode_config.plane_list,
                                 head) {
                plane->funcs->destroy(plane);
        }

        list_for_each_entry_safe(crtc, ct, &dev->mode_config.crtc_list, head) {
                crtc->funcs->destroy(crtc);
        }

        drm_gem_names_fini(&dev->mode_config.crtc_names);
}
EXPORT_SYMBOL(drm_mode_config_cleanup);

/**
 * drm_crtc_convert_to_umode - convert a drm_display_mode into a modeinfo
 * @out: drm_mode_modeinfo struct to return to the user
 * @in: drm_display_mode to use
 *
 * LOCKING:
 * None.
 *
 * Convert a drm_display_mode into a drm_mode_modeinfo structure to return to
 * the user.
 */
static void drm_crtc_convert_to_umode(struct drm_mode_modeinfo *out,
                                      const struct drm_display_mode *in)
{
        if (in->hdisplay > USHRT_MAX || in->hsync_start > USHRT_MAX ||
             in->hsync_end > USHRT_MAX || in->htotal > USHRT_MAX ||
             in->hskew > USHRT_MAX || in->vdisplay > USHRT_MAX ||
             in->vsync_start > USHRT_MAX || in->vsync_end > USHRT_MAX ||
             in->vtotal > USHRT_MAX || in->vscan > USHRT_MAX)
                DRM_WARNING("timing values too large for mode info\n");

        out->clock = in->clock;
        out->hdisplay = in->hdisplay;
        out->hsync_start = in->hsync_start;
        out->hsync_end = in->hsync_end;
        out->htotal = in->htotal;
        out->hskew = in->hskew;
        out->vdisplay = in->vdisplay;
        out->vsync_start = in->vsync_start;
        out->vsync_end = in->vsync_end;
        out->vtotal = in->vtotal;
        out->vscan = in->vscan;
        out->vrefresh = in->vrefresh;
        out->flags = in->flags;
        out->type = in->type;
        strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
        out->name[DRM_DISPLAY_MODE_LEN-1] = 0;
}

/**
 * drm_crtc_convert_to_umode - convert a modeinfo into a drm_display_mode
 * @out: drm_display_mode to return to the user
 * @in: drm_mode_modeinfo to use
 *
 * LOCKING:
 * None.
 *
 * Convert a drm_mode_modeinfo into a drm_display_mode structure to return to
 * the caller.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
static int drm_crtc_convert_umode(struct drm_display_mode *out,
                                  const struct drm_mode_modeinfo *in)
{
        if (in->clock > INT_MAX || in->vrefresh > INT_MAX)
                return -ERANGE;

        out->clock = in->clock;
        out->hdisplay = in->hdisplay;
        out->hsync_start = in->hsync_start;
        out->hsync_end = in->hsync_end;
        out->htotal = in->htotal;
        out->hskew = in->hskew;
        out->vdisplay = in->vdisplay;
        out->vsync_start = in->vsync_start;
        out->vsync_end = in->vsync_end;
        out->vtotal = in->vtotal;
        out->vscan = in->vscan;
        out->vrefresh = in->vrefresh;
        out->flags = in->flags;
        out->type = in->type;
        strncpy(out->name, in->name, DRM_DISPLAY_MODE_LEN);
        out->name[DRM_DISPLAY_MODE_LEN-1] = 0;

        return 0;
}

/**
 * drm_mode_getresources - get graphics configuration
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Construct a set of configuration description structures and return
 * them to the user, including CRTC, connector and framebuffer configuration.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_getresources(struct drm_device *dev, void *data,
                          struct drm_file *file_priv)
{
        struct drm_mode_card_res *card_res = data;
        struct list_head *lh;
        struct drm_framebuffer *fb;
        struct drm_connector *connector;
        struct drm_crtc *crtc;
        struct drm_encoder *encoder;
        int ret = 0;
        int connector_count = 0;
        int crtc_count = 0;
        int fb_count = 0;
        int encoder_count = 0;
        int copied = 0, i;
        uint32_t __user *fb_id;
        uint32_t __user *crtc_id;
        uint32_t __user *connector_id;
        uint32_t __user *encoder_id;
        struct drm_mode_group *mode_group;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        /*
         * For the non-control nodes we need to limit the list of resources
         * by IDs in the group list for this node
         */
        list_for_each(lh, &file_priv->fbs)
                fb_count++;

        mode_group = &file_priv->master->minor->mode_group;
        if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {

                list_for_each(lh, &dev->mode_config.crtc_list)
                        crtc_count++;

                list_for_each(lh, &dev->mode_config.connector_list)
                        connector_count++;

                list_for_each(lh, &dev->mode_config.encoder_list)
                        encoder_count++;
        } else {

                crtc_count = mode_group->num_crtcs;
                connector_count = mode_group->num_connectors;
                encoder_count = mode_group->num_encoders;
        }

        card_res->max_height = dev->mode_config.max_height;
        card_res->min_height = dev->mode_config.min_height;
        card_res->max_width = dev->mode_config.max_width;
        card_res->min_width = dev->mode_config.min_width;

        /* handle this in 4 parts */
        /* FBs */
        if (card_res->count_fbs >= fb_count) {
                copied = 0;
                fb_id = (uint32_t __user *)(unsigned long)card_res->fb_id_ptr;
                list_for_each_entry(fb, &file_priv->fbs, filp_head) {
                        if (put_user(fb->base.id, fb_id + copied)) {
                                ret = -EFAULT;
                                goto out;
                        }
                        copied++;
                }
        }
        card_res->count_fbs = fb_count;

        /* CRTCs */
        if (card_res->count_crtcs >= crtc_count) {
                copied = 0;
                crtc_id = (uint32_t __user *)(unsigned long)card_res->crtc_id_ptr;
                if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {
                        list_for_each_entry(crtc, &dev->mode_config.crtc_list,
                                            head) {
                                DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);
                                if (put_user(crtc->base.id, crtc_id + copied)) {
                                        ret = -EFAULT;
                                        goto out;
                                }
                                copied++;
                        }
                } else {
                        for (i = 0; i < mode_group->num_crtcs; i++) {
                                if (put_user(mode_group->id_list[i],
                                             crtc_id + copied)) {
                                        ret = -EFAULT;
                                        goto out;
                                }
                                copied++;
                        }
                }
        }
        card_res->count_crtcs = crtc_count;

        /* Encoders */
        if (card_res->count_encoders >= encoder_count) {
                copied = 0;
                encoder_id = (uint32_t __user *)(unsigned long)card_res->encoder_id_ptr;
                if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {
                        list_for_each_entry(encoder,
                                            &dev->mode_config.encoder_list,
                                            head) {
                                DRM_DEBUG_KMS("[ENCODER:%d:%s]\n", encoder->base.id,
                                                drm_get_encoder_name(encoder));
                                if (put_user(encoder->base.id, encoder_id +
                                             copied)) {
                                        ret = -EFAULT;
                                        goto out;
                                }
                                copied++;
                        }
                } else {
                        for (i = mode_group->num_crtcs; i < mode_group->num_crtcs + mode_group->num_encoders; i++) {
                                if (put_user(mode_group->id_list[i],
                                             encoder_id + copied)) {
                                        ret = -EFAULT;
                                        goto out;
                                }
                                copied++;
                        }

                }
        }
        card_res->count_encoders = encoder_count;

        /* Connectors */
        if (card_res->count_connectors >= connector_count) {
                copied = 0;
                connector_id = (uint32_t __user *)(unsigned long)card_res->connector_id_ptr;
                if (file_priv->master->minor->type == DRM_MINOR_CONTROL) {
                        list_for_each_entry(connector,
                                            &dev->mode_config.connector_list,
                                            head) {
                                DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
                                        connector->base.id,
                                        drm_get_connector_name(connector));
                                if (put_user(connector->base.id,
                                             connector_id + copied)) {
                                        ret = -EFAULT;
                                        goto out;
                                }
                                copied++;
                        }
                } else {
                        int start = mode_group->num_crtcs +
                                mode_group->num_encoders;
                        for (i = start; i < start + mode_group->num_connectors; i++) {
                                if (put_user(mode_group->id_list[i],
                                             connector_id + copied)) {
                                        ret = -EFAULT;
                                        goto out;
                                }
                                copied++;
                        }
                }
        }
        card_res->count_connectors = connector_count;

        DRM_DEBUG_KMS("CRTC[%d] CONNECTORS[%d] ENCODERS[%d]\n", card_res->count_crtcs,
                  card_res->count_connectors, card_res->count_encoders);

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/**
 * drm_mode_getcrtc - get CRTC configuration
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Construct a CRTC configuration structure to return to the user.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_getcrtc(struct drm_device *dev,
                     void *data, struct drm_file *file_priv)
{
        struct drm_mode_crtc *crtc_resp = data;
        struct drm_crtc *crtc;
        struct drm_mode_object *obj;
        int ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        obj = drm_mode_object_find(dev, crtc_resp->crtc_id,
                                   DRM_MODE_OBJECT_CRTC);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        crtc = obj_to_crtc(obj);

        crtc_resp->x = crtc->x;
        crtc_resp->y = crtc->y;
        crtc_resp->gamma_size = crtc->gamma_size;
        if (crtc->fb)
                crtc_resp->fb_id = crtc->fb->base.id;
        else
                crtc_resp->fb_id = 0;

        if (crtc->enabled) {

                drm_crtc_convert_to_umode(&crtc_resp->mode, &crtc->mode);
                crtc_resp->mode_valid = 1;

        } else {
                crtc_resp->mode_valid = 0;
        }

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/**
 * drm_mode_getconnector - get connector configuration
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Construct a connector configuration structure to return to the user.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_getconnector(struct drm_device *dev, void *data,
                          struct drm_file *file_priv)
{
        struct drm_mode_get_connector *out_resp = data;
        struct drm_mode_object *obj;
        struct drm_connector *connector;
        struct drm_display_mode *mode;
        int mode_count = 0;
        int props_count = 0;
        int encoders_count = 0;
        int ret = 0;
        int copied = 0;
        int i;
        struct drm_mode_modeinfo u_mode;
        struct drm_mode_modeinfo __user *mode_ptr;
        uint32_t __user *prop_ptr;
        uint64_t __user *prop_values;
        uint32_t __user *encoder_ptr;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        memset(&u_mode, 0, sizeof(struct drm_mode_modeinfo));

        DRM_DEBUG_KMS("[CONNECTOR:%d:?]\n", out_resp->connector_id);

        sx_xlock(&dev->mode_config.mutex);

        obj = drm_mode_object_find(dev, out_resp->connector_id,
                                   DRM_MODE_OBJECT_CONNECTOR);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        connector = obj_to_connector(obj);

        props_count = connector->properties.count;

        for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
                if (connector->encoder_ids[i] != 0) {
                        encoders_count++;
                }
        }

        if (out_resp->count_modes == 0) {
                connector->funcs->fill_modes(connector,
                                             dev->mode_config.max_width,
                                             dev->mode_config.max_height);
        }

        /* delayed so we get modes regardless of pre-fill_modes state */
        list_for_each_entry(mode, &connector->modes, head)
                mode_count++;

        out_resp->connector_id = connector->base.id;
        out_resp->connector_type = connector->connector_type;
        out_resp->connector_type_id = connector->connector_type_id;
        out_resp->mm_width = connector->display_info.width_mm;
        out_resp->mm_height = connector->display_info.height_mm;
        out_resp->subpixel = connector->display_info.subpixel_order;
        out_resp->connection = connector->status;
        if (connector->encoder)
                out_resp->encoder_id = connector->encoder->base.id;
        else
                out_resp->encoder_id = 0;

        /*
         * This ioctl is called twice, once to determine how much space is
         * needed, and the 2nd time to fill it.
         */
        if ((out_resp->count_modes >= mode_count) && mode_count) {
                copied = 0;
                mode_ptr = (struct drm_mode_modeinfo __user *)(unsigned long)out_resp->modes_ptr;
                list_for_each_entry(mode, &connector->modes, head) {
                        drm_crtc_convert_to_umode(&u_mode, mode);
                        if (copy_to_user(mode_ptr + copied,
                                         &u_mode, sizeof(u_mode))) {
                                ret = -EFAULT;
                                goto out;
                        }
                        copied++;
                }
        }
        out_resp->count_modes = mode_count;

        if ((out_resp->count_props >= props_count) && props_count) {
                copied = 0;
                prop_ptr = (uint32_t __user *)(unsigned long)(out_resp->props_ptr);
                prop_values = (uint64_t __user *)(unsigned long)(out_resp->prop_values_ptr);
                for (i = 0; i < connector->properties.count; i++) {
                        if (put_user(connector->properties.ids[i],
                                     prop_ptr + copied)) {
                                ret = -EFAULT;
                                goto out;
                        }

                        if (put_user(connector->properties.values[i],
                                     prop_values + copied)) {
                                ret = -EFAULT;
                                goto out;
                        }
                        copied++;
                }
        }
        out_resp->count_props = props_count;

        if ((out_resp->count_encoders >= encoders_count) && encoders_count) {
                copied = 0;
                encoder_ptr = (uint32_t __user *)(unsigned long)(out_resp->encoders_ptr);
                for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
                        if (connector->encoder_ids[i] != 0) {
                                if (put_user(connector->encoder_ids[i],
                                             encoder_ptr + copied)) {
                                        ret = -EFAULT;
                                        goto out;
                                }
                                copied++;
                        }
                }
        }
        out_resp->count_encoders = encoders_count;

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

int drm_mode_getencoder(struct drm_device *dev, void *data,
                        struct drm_file *file_priv)
{
        struct drm_mode_get_encoder *enc_resp = data;
        struct drm_mode_object *obj;
        struct drm_encoder *encoder;
        int ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, enc_resp->encoder_id,
                                   DRM_MODE_OBJECT_ENCODER);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        encoder = obj_to_encoder(obj);

        if (encoder->crtc)
                enc_resp->crtc_id = encoder->crtc->base.id;
        else
                enc_resp->crtc_id = 0;
        enc_resp->encoder_type = encoder->encoder_type;
        enc_resp->encoder_id = encoder->base.id;
        enc_resp->possible_crtcs = encoder->possible_crtcs;
        enc_resp->possible_clones = encoder->possible_clones;

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/**
 * drm_mode_getplane_res - get plane info
 * @dev: DRM device
 * @data: ioctl data
 * @file_priv: DRM file info
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Return an plane count and set of IDs.
 */
int drm_mode_getplane_res(struct drm_device *dev, void *data,
                            struct drm_file *file_priv)
{
        struct drm_mode_get_plane_res *plane_resp = data;
        struct drm_mode_config *config;
        struct drm_plane *plane;
        uint32_t __user *plane_ptr;
        int copied = 0, ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        config = &dev->mode_config;

        /*
         * This ioctl is called twice, once to determine how much space is
         * needed, and the 2nd time to fill it.
         */
        if (config->num_plane &&
            (plane_resp->count_planes >= config->num_plane)) {
                plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;

                list_for_each_entry(plane, &config->plane_list, head) {
                        if (put_user(plane->base.id, plane_ptr + copied)) {
                                ret = -EFAULT;
                                goto out;
                        }
                        copied++;
                }
        }
        plane_resp->count_planes = config->num_plane;

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/**
 * drm_mode_getplane - get plane info
 * @dev: DRM device
 * @data: ioctl data
 * @file_priv: DRM file info
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Return plane info, including formats supported, gamma size, any
 * current fb, etc.
 */
int drm_mode_getplane(struct drm_device *dev, void *data,
                        struct drm_file *file_priv)
{
        struct drm_mode_get_plane *plane_resp = data;
        struct drm_mode_object *obj;
        struct drm_plane *plane;
        uint32_t __user *format_ptr;
        int ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, plane_resp->plane_id,
                                   DRM_MODE_OBJECT_PLANE);
        if (!obj) {
                ret = -ENOENT;
                goto out;
        }
        plane = obj_to_plane(obj);

        if (plane->crtc)
                plane_resp->crtc_id = plane->crtc->base.id;
        else
                plane_resp->crtc_id = 0;

        if (plane->fb)
                plane_resp->fb_id = plane->fb->base.id;
        else
                plane_resp->fb_id = 0;

        plane_resp->plane_id = plane->base.id;
        plane_resp->possible_crtcs = plane->possible_crtcs;
        plane_resp->gamma_size = plane->gamma_size;

        /*
         * This ioctl is called twice, once to determine how much space is
         * needed, and the 2nd time to fill it.
         */
        if (plane->format_count &&
            (plane_resp->count_format_types >= plane->format_count)) {
                format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
                if (copy_to_user(format_ptr,
                                 plane->format_types,
                                 sizeof(uint32_t) * plane->format_count)) {
                        ret = -EFAULT;
                        goto out;
                }
        }
        plane_resp->count_format_types = plane->format_count;

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/**
 * drm_mode_setplane - set up or tear down an plane
 * @dev: DRM device
 * @data: ioctl data*
 * @file_prive: DRM file info
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Set plane info, including placement, fb, scaling, and other factors.
 * Or pass a NULL fb to disable.
 */
int drm_mode_setplane(struct drm_device *dev, void *data,
                        struct drm_file *file_priv)
{
        struct drm_mode_set_plane *plane_req = data;
        struct drm_mode_object *obj;
        struct drm_plane *plane;
        struct drm_crtc *crtc;
        struct drm_framebuffer *fb;
        int ret = 0;
        unsigned int fb_width, fb_height;
        int i;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        /*
         * First, find the plane, crtc, and fb objects.  If not available,
         * we don't bother to call the driver.
         */
        obj = drm_mode_object_find(dev, plane_req->plane_id,
                                   DRM_MODE_OBJECT_PLANE);
        if (!obj) {
                DRM_DEBUG_KMS("Unknown plane ID %d\n",
                              plane_req->plane_id);
                ret = -ENOENT;
                goto out;
        }
        plane = obj_to_plane(obj);

        /* No fb means shut it down */
        if (!plane_req->fb_id) {
                plane->funcs->disable_plane(plane);
                plane->crtc = NULL;
                plane->fb = NULL;
                goto out;
        }

        obj = drm_mode_object_find(dev, plane_req->crtc_id,
                                   DRM_MODE_OBJECT_CRTC);
        if (!obj) {
                DRM_DEBUG_KMS("Unknown crtc ID %d\n",
                              plane_req->crtc_id);
                ret = -ENOENT;
                goto out;
        }
        crtc = obj_to_crtc(obj);

        obj = drm_mode_object_find(dev, plane_req->fb_id,
                                   DRM_MODE_OBJECT_FB);
        if (!obj) {
                DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
                              plane_req->fb_id);
                ret = -ENOENT;
                goto out;
        }
        fb = obj_to_fb(obj);

        /* Check whether this plane supports the fb pixel format. */
        for (i = 0; i < plane->format_count; i++)
                if (fb->pixel_format == plane->format_types[i])
                        break;
        if (i == plane->format_count) {
                DRM_DEBUG_KMS("Invalid pixel format 0x%08x\n", fb->pixel_format);
                ret = -EINVAL;
                goto out;
        }

        fb_width = fb->width << 16;
        fb_height = fb->height << 16;

        /* Make sure source coordinates are inside the fb. */
        if (plane_req->src_w > fb_width ||
            plane_req->src_x > fb_width - plane_req->src_w ||
            plane_req->src_h > fb_height ||
            plane_req->src_y > fb_height - plane_req->src_h) {
                DRM_DEBUG_KMS("Invalid source coordinates "
                              "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
                              plane_req->src_w >> 16,
                              ((plane_req->src_w & 0xffff) * 15625) >> 10,
                              plane_req->src_h >> 16,
                              ((plane_req->src_h & 0xffff) * 15625) >> 10,
                              plane_req->src_x >> 16,
                              ((plane_req->src_x & 0xffff) * 15625) >> 10,
                              plane_req->src_y >> 16,
                              ((plane_req->src_y & 0xffff) * 15625) >> 10);
                ret = -ENOSPC;
                goto out;
        }

        /* Give drivers some help against integer overflows */
        if (plane_req->crtc_w > INT_MAX ||
            plane_req->crtc_x > INT_MAX - (int32_t) plane_req->crtc_w ||
            plane_req->crtc_h > INT_MAX ||
            plane_req->crtc_y > INT_MAX - (int32_t) plane_req->crtc_h) {
                DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
                              plane_req->crtc_w, plane_req->crtc_h,
                              plane_req->crtc_x, plane_req->crtc_y);
                ret = -ERANGE;
                goto out;
        }

        ret = plane->funcs->update_plane(plane, crtc, fb,
                                         plane_req->crtc_x, plane_req->crtc_y,
                                         plane_req->crtc_w, plane_req->crtc_h,
                                         plane_req->src_x, plane_req->src_y,
                                         plane_req->src_w, plane_req->src_h);
        if (!ret) {
                plane->crtc = crtc;
                plane->fb = fb;
        }

out:
        sx_xunlock(&dev->mode_config.mutex);

        return ret;
}

/**
 * drm_mode_setcrtc - set CRTC configuration
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Build a new CRTC configuration based on user request.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_setcrtc(struct drm_device *dev, void *data,
                     struct drm_file *file_priv)
{
        struct drm_mode_config *config = &dev->mode_config;
        struct drm_mode_crtc *crtc_req = data;
        struct drm_mode_object *obj;
        struct drm_crtc *crtc;
        struct drm_connector **connector_set = NULL, *connector;
        struct drm_framebuffer *fb = NULL;
        struct drm_display_mode *mode = NULL;
        struct drm_mode_set set;
        uint32_t __user *set_connectors_ptr;
        int ret;
        int i;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        /* For some reason crtc x/y offsets are signed internally. */
        if (crtc_req->x > INT_MAX || crtc_req->y > INT_MAX)
                return -ERANGE;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, crtc_req->crtc_id,
                                   DRM_MODE_OBJECT_CRTC);
        if (!obj) {
                DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
                ret = -EINVAL;
                goto out;
        }
        crtc = obj_to_crtc(obj);
        DRM_DEBUG_KMS("[CRTC:%d]\n", crtc->base.id);

        if (crtc_req->mode_valid) {
                int hdisplay, vdisplay;
                /* If we have a mode we need a framebuffer. */
                /* If we pass -1, set the mode with the currently bound fb */
                if (crtc_req->fb_id == -1) {
                        if (!crtc->fb) {
                                DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
                                ret = -EINVAL;
                                goto out;
                        }
                        fb = crtc->fb;
                } else {
                        obj = drm_mode_object_find(dev, crtc_req->fb_id,
                                                   DRM_MODE_OBJECT_FB);
                        if (!obj) {
                                DRM_DEBUG_KMS("Unknown FB ID%d\n",
                                                crtc_req->fb_id);
                                ret = -EINVAL;
                                goto out;
                        }
                        fb = obj_to_fb(obj);
                }

                mode = drm_mode_create(dev);
                if (!mode) {
                        ret = -ENOMEM;
                        goto out;
                }

                ret = drm_crtc_convert_umode(mode, &crtc_req->mode);
                if (ret) {
                        DRM_DEBUG_KMS("Invalid mode\n");
                        goto out;
                }

                drm_mode_set_crtcinfo(mode, CRTC_INTERLACE_HALVE_V);

                hdisplay = mode->hdisplay;
                vdisplay = mode->vdisplay;

                if (crtc->invert_dimensions) {
                        int tmp;
                        tmp = vdisplay;
                        vdisplay = hdisplay;
                        hdisplay = tmp;
                }

                if (hdisplay > fb->width ||
                    vdisplay > fb->height ||
                    crtc_req->x > fb->width - hdisplay ||
                    crtc_req->y > fb->height - vdisplay) {
                        DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
                                      fb->width, fb->height,
                                      hdisplay, vdisplay, crtc_req->x, crtc_req->y,
                                      crtc->invert_dimensions ? " (inverted)" : "");
                        ret = -ENOSPC;
                        goto out;
                }
        }

        if (crtc_req->count_connectors == 0 && mode) {
                DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
                ret = -EINVAL;
                goto out;
        }

        if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
                DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
                          crtc_req->count_connectors);
                ret = -EINVAL;
                goto out;
        }

        if (crtc_req->count_connectors > 0) {
                u32 out_id;

                /* Avoid unbounded kernel memory allocation */
                if (crtc_req->count_connectors > config->num_connector) {
                        ret = -EINVAL;
                        goto out;
                }

                connector_set = malloc(crtc_req->count_connectors *
                                        sizeof(struct drm_connector *),
                                        DRM_MEM_KMS, M_WAITOK);

                for (i = 0; i < crtc_req->count_connectors; i++) {
                        set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
                        if (get_user(out_id, &set_connectors_ptr[i])) {
                                ret = -EFAULT;
                                goto out;
                        }

                        obj = drm_mode_object_find(dev, out_id,
                                                   DRM_MODE_OBJECT_CONNECTOR);
                        if (!obj) {
                                DRM_DEBUG_KMS("Connector id %d unknown\n",
                                                out_id);
                                ret = -EINVAL;
                                goto out;
                        }
                        connector = obj_to_connector(obj);
                        DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
                                        connector->base.id,
                                        drm_get_connector_name(connector));

                        connector_set[i] = connector;
                }
        }

        set.crtc = crtc;
        set.x = crtc_req->x;
        set.y = crtc_req->y;
        set.mode = mode;
        set.connectors = connector_set;
        set.num_connectors = crtc_req->count_connectors;
        set.fb = fb;
        ret = crtc->funcs->set_config(&set);

out:
        free(connector_set, DRM_MEM_KMS);
        drm_mode_destroy(dev, mode);
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

int drm_mode_cursor_ioctl(struct drm_device *dev,
                        void *data, struct drm_file *file_priv)
{
        struct drm_mode_cursor *req = data;
        struct drm_mode_object *obj;
        struct drm_crtc *crtc;
        int ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, req->crtc_id, DRM_MODE_OBJECT_CRTC);
        if (!obj) {
                DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
                ret = -EINVAL;
                goto out;
        }
        crtc = obj_to_crtc(obj);

        if (req->flags & DRM_MODE_CURSOR_BO) {
                if (!crtc->funcs->cursor_set) {
                        ret = -ENXIO;
                        goto out;
                }
                /* Turns off the cursor if handle is 0 */
                ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
                                              req->width, req->height);
        }

        if (req->flags & DRM_MODE_CURSOR_MOVE) {
                if (crtc->funcs->cursor_move) {
                        ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
                } else {
                        ret = -EFAULT;
                        goto out;
                }
        }
out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/* Original addfb only supported RGB formats, so figure out which one */
uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth)
{
        uint32_t fmt;

        switch (bpp) {
        case 8:
                fmt = DRM_FORMAT_C8;
                break;
        case 16:
                if (depth == 15)
                        fmt = DRM_FORMAT_XRGB1555;
                else
                        fmt = DRM_FORMAT_RGB565;
                break;
        case 24:
                fmt = DRM_FORMAT_RGB888;
                break;
        case 32:
                if (depth == 24)
                        fmt = DRM_FORMAT_XRGB8888;
                else if (depth == 30)
                        fmt = DRM_FORMAT_XRGB2101010;
                else
                        fmt = DRM_FORMAT_ARGB8888;
                break;
        default:
                DRM_ERROR("bad bpp, assuming x8r8g8b8 pixel format\n");
                fmt = DRM_FORMAT_XRGB8888;
                break;
        }

        return fmt;
}
EXPORT_SYMBOL(drm_mode_legacy_fb_format);

/**
 * drm_mode_addfb - add an FB to the graphics configuration
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Add a new FB to the specified CRTC, given a user request.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_addfb(struct drm_device *dev,
                   void *data, struct drm_file *file_priv)
{
        struct drm_mode_fb_cmd *or = data;
        struct drm_mode_fb_cmd2 r = {};
        struct drm_mode_config *config = &dev->mode_config;
        struct drm_framebuffer *fb;
        int ret = 0;

        /* Use new struct with format internally */
        r.fb_id = or->fb_id;
        r.width = or->width;
        r.height = or->height;
        r.pitches[0] = or->pitch;
        r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth);
        r.handles[0] = or->handle;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        if ((config->min_width > r.width) || (r.width > config->max_width))
                return -EINVAL;

        if ((config->min_height > r.height) || (r.height > config->max_height))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        /* TODO check buffer is sufficiently large */
        /* TODO setup destructor callback */

        ret = dev->mode_config.funcs->fb_create(dev, file_priv, &r, &fb);
        if (ret != 0) {
                DRM_DEBUG_KMS("could not create framebuffer\n");
                goto out;
        }

        or->fb_id = fb->base.id;
        list_add(&fb->filp_head, &file_priv->fbs);
        DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

static int format_check(const struct drm_mode_fb_cmd2 *r)
{
        uint32_t format = r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN;

        switch (format) {
        case DRM_FORMAT_C8:
        case DRM_FORMAT_RGB332:
        case DRM_FORMAT_BGR233:
        case DRM_FORMAT_XRGB4444:
        case DRM_FORMAT_XBGR4444:
        case DRM_FORMAT_RGBX4444:
        case DRM_FORMAT_BGRX4444:
        case DRM_FORMAT_ARGB4444:
        case DRM_FORMAT_ABGR4444:
        case DRM_FORMAT_RGBA4444:
        case DRM_FORMAT_BGRA4444:
        case DRM_FORMAT_XRGB1555:
        case DRM_FORMAT_XBGR1555:
        case DRM_FORMAT_RGBX5551:
        case DRM_FORMAT_BGRX5551:
        case DRM_FORMAT_ARGB1555:
        case DRM_FORMAT_ABGR1555:
        case DRM_FORMAT_RGBA5551:
        case DRM_FORMAT_BGRA5551:
        case DRM_FORMAT_RGB565:
        case DRM_FORMAT_BGR565:
        case DRM_FORMAT_RGB888:
        case DRM_FORMAT_BGR888:
        case DRM_FORMAT_XRGB8888:
        case DRM_FORMAT_XBGR8888:
        case DRM_FORMAT_RGBX8888:
        case DRM_FORMAT_BGRX8888:
        case DRM_FORMAT_ARGB8888:
        case DRM_FORMAT_ABGR8888:
        case DRM_FORMAT_RGBA8888:
        case DRM_FORMAT_BGRA8888:
        case DRM_FORMAT_XRGB2101010:
        case DRM_FORMAT_XBGR2101010:
        case DRM_FORMAT_RGBX1010102:
        case DRM_FORMAT_BGRX1010102:
        case DRM_FORMAT_ARGB2101010:
        case DRM_FORMAT_ABGR2101010:
        case DRM_FORMAT_RGBA1010102:
        case DRM_FORMAT_BGRA1010102:
        case DRM_FORMAT_YUYV:
        case DRM_FORMAT_YVYU:
        case DRM_FORMAT_UYVY:
        case DRM_FORMAT_VYUY:
        case DRM_FORMAT_AYUV:
        case DRM_FORMAT_NV12:
        case DRM_FORMAT_NV21:
        case DRM_FORMAT_NV16:
        case DRM_FORMAT_NV61:
        case DRM_FORMAT_NV24:
        case DRM_FORMAT_NV42:
        case DRM_FORMAT_YUV410:
        case DRM_FORMAT_YVU410:
        case DRM_FORMAT_YUV411:
        case DRM_FORMAT_YVU411:
        case DRM_FORMAT_YUV420:
        case DRM_FORMAT_YVU420:
        case DRM_FORMAT_YUV422:
        case DRM_FORMAT_YVU422:
        case DRM_FORMAT_YUV444:
        case DRM_FORMAT_YVU444:
                return 0;
        default:
                return -EINVAL;
        }
}

static int framebuffer_check(const struct drm_mode_fb_cmd2 *r)
{
        int ret, hsub, vsub, num_planes, i;

        ret = format_check(r);
        if (ret) {
                DRM_DEBUG_KMS("bad framebuffer format 0x%08x\n", r->pixel_format);
                return ret;
        }

        hsub = drm_format_horz_chroma_subsampling(r->pixel_format);
        vsub = drm_format_vert_chroma_subsampling(r->pixel_format);
        num_planes = drm_format_num_planes(r->pixel_format);

        if (r->width == 0 || r->width % hsub) {
                DRM_DEBUG_KMS("bad framebuffer width %u\n", r->height);
                return -EINVAL;
        }

        if (r->height == 0 || r->height % vsub) {
                DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height);
                return -EINVAL;
        }

        for (i = 0; i < num_planes; i++) {
                unsigned int width = r->width / (i != 0 ? hsub : 1);
                unsigned int height = r->height / (i != 0 ? vsub : 1);
                unsigned int cpp = drm_format_plane_cpp(r->pixel_format, i);

                if (!r->handles[i]) {
                        DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i);
                        return -EINVAL;
                }

                if ((uint64_t) width * cpp > UINT_MAX)
                        return -ERANGE;

                if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX)
                        return -ERANGE;

                if (r->pitches[i] < width * cpp) {
                        DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i);
                        return -EINVAL;
                }
        }

        return 0;
}

/**
 * drm_mode_addfb2 - add an FB to the graphics configuration
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Add a new FB to the specified CRTC, given a user request with format.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_addfb2(struct drm_device *dev,
                    void *data, struct drm_file *file_priv)
{
        struct drm_mode_fb_cmd2 *r = data;
        struct drm_mode_config *config = &dev->mode_config;
        struct drm_framebuffer *fb;
        int ret;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        if (r->flags & ~DRM_MODE_FB_INTERLACED) {
                DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags);
                return -EINVAL;
        }

        if ((config->min_width > r->width) || (r->width > config->max_width)) {
                DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n",
                          r->width, config->min_width, config->max_width);
                return -EINVAL;
        }
        if ((config->min_height > r->height) || (r->height > config->max_height)) {
                DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n",
                          r->height, config->min_height, config->max_height);
                return -EINVAL;
        }

        ret = framebuffer_check(r);
        if (ret)
                return ret;

        sx_xlock(&dev->mode_config.mutex);

        ret = dev->mode_config.funcs->fb_create(dev, file_priv, r, &fb);
        if (ret != 0) {
                DRM_DEBUG_KMS("could not create framebuffer\n");
                goto out;
        }

        r->fb_id = fb->base.id;
        list_add(&fb->filp_head, &file_priv->fbs);
        DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id);

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/**
 * drm_mode_rmfb - remove an FB from the configuration
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Remove the FB specified by the user.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_rmfb(struct drm_device *dev,
                   void *data, struct drm_file *file_priv)
{
        struct drm_mode_object *obj;
        struct drm_framebuffer *fb = NULL;
        struct drm_framebuffer *fbl = NULL;
        uint32_t *id = data;
        int ret = 0;
        int found = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, *id, DRM_MODE_OBJECT_FB);
        /* TODO check that we really get a framebuffer back. */
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        fb = obj_to_fb(obj);

        list_for_each_entry(fbl, &file_priv->fbs, filp_head)
                if (fb == fbl)
                        found = 1;

        if (!found) {
                ret = -EINVAL;
                goto out;
        }

        drm_framebuffer_remove(fb);

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

/**
 * drm_mode_getfb - get FB info
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Lookup the FB given its ID and return info about it.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_getfb(struct drm_device *dev,
                   void *data, struct drm_file *file_priv)
{
        struct drm_mode_fb_cmd *r = data;
        struct drm_mode_object *obj;
        struct drm_framebuffer *fb;
        int ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, r->fb_id, DRM_MODE_OBJECT_FB);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        fb = obj_to_fb(obj);

        r->height = fb->height;
        r->width = fb->width;
        r->depth = fb->depth;
        r->bpp = fb->bits_per_pixel;
        r->pitch = fb->pitches[0];
        r->handle = 0;
        fb->funcs->create_handle(fb, file_priv, &r->handle);

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

int drm_mode_dirtyfb_ioctl(struct drm_device *dev,
                           void *data, struct drm_file *file_priv)
{
        struct drm_clip_rect __user *clips_ptr;
        struct drm_clip_rect *clips = NULL;
        struct drm_mode_fb_dirty_cmd *r = data;
        struct drm_mode_object *obj;
        struct drm_framebuffer *fb;
        unsigned flags;
        int num_clips;
        int ret;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, r->fb_id, DRM_MODE_OBJECT_FB);
        if (!obj) {
                ret = -EINVAL;
                goto out_err1;
        }
        fb = obj_to_fb(obj);

        num_clips = r->num_clips;
        clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr;

        if (!num_clips != !clips_ptr) {
                ret = -EINVAL;
                goto out_err1;
        }

        flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags;

        /* If userspace annotates copy, clips must come in pairs */
        if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) {
                ret = -EINVAL;
                goto out_err1;
        }

        if (num_clips && clips_ptr) {
                if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) {
                        ret = -EINVAL;
                        goto out_err1;
                }
                clips = malloc(num_clips * sizeof(*clips), DRM_MEM_KMS,
                    M_WAITOK | M_ZERO);
                ret = copy_from_user(clips, clips_ptr,
                                     num_clips * sizeof(*clips));
                if (ret) {
                        ret = -EFAULT;
                        goto out_err2;
                }
        }

        if (fb->funcs->dirty) {
                ret = fb->funcs->dirty(fb, file_priv, flags, r->color,
                                       clips, num_clips);
        } else {
                ret = -ENOSYS;
                goto out_err2;
        }

out_err2:
        free(clips, DRM_MEM_KMS);
out_err1:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}


/**
 * drm_fb_release - remove and free the FBs on this file
 * @filp: file * from the ioctl
 *
 * LOCKING:
 * Takes mode config lock.
 *
 * Destroy all the FBs associated with @filp.
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
void drm_fb_release(struct drm_file *priv)
{
        struct drm_device *dev = priv->minor->dev;
        struct drm_framebuffer *fb, *tfb;

        sx_xlock(&dev->mode_config.mutex);
        list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) {
                drm_framebuffer_remove(fb);
        }
        sx_xunlock(&dev->mode_config.mutex);
}

/**
 * drm_mode_attachmode - add a mode to the user mode list
 * @dev: DRM device
 * @connector: connector to add the mode to
 * @mode: mode to add
 *
 * Add @mode to @connector's user mode list.
 */
static void drm_mode_attachmode(struct drm_device *dev,
                                struct drm_connector *connector,
                                struct drm_display_mode *mode)
{
        list_add_tail(&mode->head, &connector->user_modes);
}

int drm_mode_attachmode_crtc(struct drm_device *dev, struct drm_crtc *crtc,
                             const struct drm_display_mode *mode)
{
        struct drm_connector *connector;
        int ret = 0;
        struct drm_display_mode *dup_mode, *next;
        DRM_LIST_HEAD(list);

        list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
                if (!connector->encoder)
                        continue;
                if (connector->encoder->crtc == crtc) {
                        dup_mode = drm_mode_duplicate(dev, mode);
                        if (!dup_mode) {
                                ret = -ENOMEM;
                                goto out;
                        }
                        list_add_tail(&dup_mode->head, &list);
                }
        }

        list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
                if (!connector->encoder)
                        continue;
                if (connector->encoder->crtc == crtc)
                        list_move_tail(list.next, &connector->user_modes);
        }

        MPASS(!list_empty(&list));

 out:
        list_for_each_entry_safe(dup_mode, next, &list, head)
                drm_mode_destroy(dev, dup_mode);

        return ret;
}
EXPORT_SYMBOL(drm_mode_attachmode_crtc);

static int drm_mode_detachmode(struct drm_device *dev,
                               struct drm_connector *connector,
                               struct drm_display_mode *mode)
{
        int found = 0;
        int ret = 0;
        struct drm_display_mode *match_mode, *t;

        list_for_each_entry_safe(match_mode, t, &connector->user_modes, head) {
                if (drm_mode_equal(match_mode, mode)) {
                        list_del(&match_mode->head);
                        drm_mode_destroy(dev, match_mode);
                        found = 1;
                        break;
                }
        }

        if (!found)
                ret = -EINVAL;

        return ret;
}

int drm_mode_detachmode_crtc(struct drm_device *dev, struct drm_display_mode *mode)
{
        struct drm_connector *connector;

        list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
                drm_mode_detachmode(dev, connector, mode);
        }
        return 0;
}
EXPORT_SYMBOL(drm_mode_detachmode_crtc);

/**
 * drm_fb_attachmode - Attach a user mode to an connector
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * This attaches a user specified mode to an connector.
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_attachmode_ioctl(struct drm_device *dev,
                              void *data, struct drm_file *file_priv)
{
        struct drm_mode_mode_cmd *mode_cmd = data;
        struct drm_connector *connector;
        struct drm_display_mode *mode;
        struct drm_mode_object *obj;
        struct drm_mode_modeinfo *umode = &mode_cmd->mode;
        int ret;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        obj = drm_mode_object_find(dev, mode_cmd->connector_id, DRM_MODE_OBJECT_CONNECTOR);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        connector = obj_to_connector(obj);

        mode = drm_mode_create(dev);
        if (!mode) {
                ret = -ENOMEM;
                goto out;
        }

        ret = drm_crtc_convert_umode(mode, umode);
        if (ret) {
                DRM_DEBUG_KMS("Invalid mode\n");
                drm_mode_destroy(dev, mode);
                goto out;
        }

        drm_mode_attachmode(dev, connector, mode);
out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}


/**
 * drm_fb_detachmode - Detach a user specified mode from an connector
 * @inode: inode from the ioctl
 * @filp: file * from the ioctl
 * @cmd: cmd from ioctl
 * @arg: arg from ioctl
 *
 * Called by the user via ioctl.
 *
 * RETURNS:
 * Zero on success, errno on failure.
 */
int drm_mode_detachmode_ioctl(struct drm_device *dev,
                              void *data, struct drm_file *file_priv)
{
        struct drm_mode_object *obj;
        struct drm_mode_mode_cmd *mode_cmd = data;
        struct drm_connector *connector;
        struct drm_display_mode mode;
        struct drm_mode_modeinfo *umode = &mode_cmd->mode;
        int ret;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        obj = drm_mode_object_find(dev, mode_cmd->connector_id, DRM_MODE_OBJECT_CONNECTOR);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        connector = obj_to_connector(obj);

        ret = drm_crtc_convert_umode(&mode, umode);
        if (ret) {
                DRM_DEBUG_KMS("Invalid mode\n");
                goto out;
        }

        ret = drm_mode_detachmode(dev, connector, &mode);
out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

struct drm_property *drm_property_create(struct drm_device *dev, int flags,
                                         const char *name, int num_values)
{
        struct drm_property *property = NULL;
        int ret;

        property = malloc(sizeof(struct drm_property), DRM_MEM_KMS,
            M_WAITOK | M_ZERO);

        if (num_values)
                property->values = malloc(sizeof(uint64_t)*num_values, DRM_MEM_KMS,
                    M_WAITOK | M_ZERO);

        ret = drm_mode_object_get(dev, &property->base, DRM_MODE_OBJECT_PROPERTY);
        if (ret)
                goto fail;

        property->flags = flags;
        property->num_values = num_values;
        INIT_LIST_HEAD(&property->enum_blob_list);

        if (name) {
                strncpy(property->name, name, DRM_PROP_NAME_LEN);
                property->name[DRM_PROP_NAME_LEN-1] = '\0';
        }

        list_add_tail(&property->head, &dev->mode_config.property_list);
        return property;
fail:
        free(property->values, DRM_MEM_KMS);
        free(property, DRM_MEM_KMS);
        return NULL;
}
EXPORT_SYMBOL(drm_property_create);

struct drm_property *drm_property_create_enum(struct drm_device *dev, int flags,
                                         const char *name,
                                         const struct drm_prop_enum_list *props,
                                         int num_values)
{
        struct drm_property *property;
        int i, ret;

        flags |= DRM_MODE_PROP_ENUM;

        property = drm_property_create(dev, flags, name, num_values);
        if (!property)
                return NULL;

        for (i = 0; i < num_values; i++) {
                ret = drm_property_add_enum(property, i,
                                      props[i].type,
                                      props[i].name);
                if (ret) {
                        drm_property_destroy(dev, property);
                        return NULL;
                }
        }

        return property;
}
EXPORT_SYMBOL(drm_property_create_enum);

struct drm_property *drm_property_create_bitmask(struct drm_device *dev,
                                         int flags, const char *name,
                                         const struct drm_prop_enum_list *props,
                                         int num_values)
{
        struct drm_property *property;
        int i, ret;

        flags |= DRM_MODE_PROP_BITMASK;

        property = drm_property_create(dev, flags, name, num_values);
        if (!property)
                return NULL;

        for (i = 0; i < num_values; i++) {
                ret = drm_property_add_enum(property, i,
                                      props[i].type,
                                      props[i].name);
                if (ret) {
                        drm_property_destroy(dev, property);
                        return NULL;
                }
        }

        return property;
}
EXPORT_SYMBOL(drm_property_create_bitmask);

struct drm_property *drm_property_create_range(struct drm_device *dev, int flags,
                                         const char *name,
                                         uint64_t min, uint64_t max)
{
        struct drm_property *property;

        flags |= DRM_MODE_PROP_RANGE;

        property = drm_property_create(dev, flags, name, 2);
        if (!property)
                return NULL;

        property->values[0] = min;
        property->values[1] = max;

        return property;
}
EXPORT_SYMBOL(drm_property_create_range);

int drm_property_add_enum(struct drm_property *property, int index,
                          uint64_t value, const char *name)
{
        struct drm_property_enum *prop_enum;

        if (!(property->flags & (DRM_MODE_PROP_ENUM | DRM_MODE_PROP_BITMASK)))
                return -EINVAL;

        /*
         * Bitmask enum properties have the additional constraint of values
         * from 0 to 63
         */
        if ((property->flags & DRM_MODE_PROP_BITMASK) && (value > 63))
                return -EINVAL;

        if (!list_empty(&property->enum_blob_list)) {
                list_for_each_entry(prop_enum, &property->enum_blob_list, head) {
                        if (prop_enum->value == value) {
                                strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
                                prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
                                return 0;
                        }
                }
        }

        prop_enum = malloc(sizeof(struct drm_property_enum), DRM_MEM_KMS,
            M_WAITOK | M_ZERO);
        strncpy(prop_enum->name, name, DRM_PROP_NAME_LEN);
        prop_enum->name[DRM_PROP_NAME_LEN-1] = '\0';
        prop_enum->value = value;

        property->values[index] = value;
        list_add_tail(&prop_enum->head, &property->enum_blob_list);
        return 0;
}
EXPORT_SYMBOL(drm_property_add_enum);

void drm_property_destroy(struct drm_device *dev, struct drm_property *property)
{
        struct drm_property_enum *prop_enum, *pt;

        list_for_each_entry_safe(prop_enum, pt, &property->enum_blob_list, head) {
                list_del(&prop_enum->head);
                free(prop_enum, DRM_MEM_KMS);
        }

        if (property->num_values)
                free(property->values, DRM_MEM_KMS);
        drm_mode_object_put(dev, &property->base);
        list_del(&property->head);
        free(property, DRM_MEM_KMS);
}
EXPORT_SYMBOL(drm_property_destroy);

void drm_object_attach_property(struct drm_mode_object *obj,
                                struct drm_property *property,
                                uint64_t init_val)
{
        int count = obj->properties->count;

        if (count == DRM_OBJECT_MAX_PROPERTY) {
                DRM_WARNING("Failed to attach object property (type: 0x%x). Please "
                        "increase DRM_OBJECT_MAX_PROPERTY by 1 for each time "
                        "you see this message on the same object type.\n",
                        obj->type);
                return;
        }

        obj->properties->ids[count] = property->base.id;
        obj->properties->values[count] = init_val;
        obj->properties->count++;
}
EXPORT_SYMBOL(drm_object_attach_property);

int drm_object_property_set_value(struct drm_mode_object *obj,
                                  struct drm_property *property, uint64_t val)
{
        int i;

        for (i = 0; i < obj->properties->count; i++) {
                if (obj->properties->ids[i] == property->base.id) {
                        obj->properties->values[i] = val;
                        return 0;
                }
        }

        return -EINVAL;
}
EXPORT_SYMBOL(drm_object_property_set_value);

int drm_object_property_get_value(struct drm_mode_object *obj,
                                  struct drm_property *property, uint64_t *val)
{
        int i;

        for (i = 0; i < obj->properties->count; i++) {
                if (obj->properties->ids[i] == property->base.id) {
                        *val = obj->properties->values[i];
                        return 0;
                }
        }

        return -EINVAL;
}
EXPORT_SYMBOL(drm_object_property_get_value);

int drm_mode_getproperty_ioctl(struct drm_device *dev,
                               void *data, struct drm_file *file_priv)
{
        struct drm_mode_object *obj;
        struct drm_mode_get_property *out_resp = data;
        struct drm_property *property;
        int enum_count = 0;
        int blob_count = 0;
        int value_count = 0;
        int ret = 0, i;
        int copied;
        struct drm_property_enum *prop_enum;
        struct drm_mode_property_enum __user *enum_ptr;
        struct drm_property_blob *prop_blob;
        uint32_t __user *blob_id_ptr;
        uint64_t __user *values_ptr;
        uint32_t __user *blob_length_ptr;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, out_resp->prop_id, DRM_MODE_OBJECT_PROPERTY);
        if (!obj) {
                ret = -EINVAL;
                goto done;
        }
        property = obj_to_property(obj);

        if (property->flags & (DRM_MODE_PROP_ENUM | DRM_MODE_PROP_BITMASK)) {
                list_for_each_entry(prop_enum, &property->enum_blob_list, head)
                        enum_count++;
        } else if (property->flags & DRM_MODE_PROP_BLOB) {
                list_for_each_entry(prop_blob, &property->enum_blob_list, head)
                        blob_count++;
        }

        value_count = property->num_values;

        strncpy(out_resp->name, property->name, DRM_PROP_NAME_LEN);
        out_resp->name[DRM_PROP_NAME_LEN-1] = 0;
        out_resp->flags = property->flags;

        if ((out_resp->count_values >= value_count) && value_count) {
                values_ptr = (uint64_t __user *)(unsigned long)out_resp->values_ptr;
                for (i = 0; i < value_count; i++) {
                        if (copy_to_user(values_ptr + i, &property->values[i], sizeof(uint64_t))) {
                                ret = -EFAULT;
                                goto done;
                        }
                }
        }
        out_resp->count_values = value_count;

        if (property->flags & (DRM_MODE_PROP_ENUM | DRM_MODE_PROP_BITMASK)) {
                if ((out_resp->count_enum_blobs >= enum_count) && enum_count) {
                        copied = 0;
                        enum_ptr = (struct drm_mode_property_enum __user *)(unsigned long)out_resp->enum_blob_ptr;
                        list_for_each_entry(prop_enum, &property->enum_blob_list, head) {

                                if (copy_to_user(&enum_ptr[copied].value, &prop_enum->value, sizeof(uint64_t))) {
                                        ret = -EFAULT;
                                        goto done;
                                }

                                if (copy_to_user(&enum_ptr[copied].name,
                                                 &prop_enum->name, DRM_PROP_NAME_LEN)) {
                                        ret = -EFAULT;
                                        goto done;
                                }
                                copied++;
                        }
                }
                out_resp->count_enum_blobs = enum_count;
        }

        if (property->flags & DRM_MODE_PROP_BLOB) {
                if ((out_resp->count_enum_blobs >= blob_count) && blob_count) {
                        copied = 0;
                        blob_id_ptr = (uint32_t __user *)(unsigned long)out_resp->enum_blob_ptr;
                        blob_length_ptr = (uint32_t __user *)(unsigned long)out_resp->values_ptr;

                        list_for_each_entry(prop_blob, &property->enum_blob_list, head) {
                                if (put_user(prop_blob->base.id, blob_id_ptr + copied)) {
                                        ret = -EFAULT;
                                        goto done;
                                }

                                if (put_user(prop_blob->length, blob_length_ptr + copied)) {
                                        ret = -EFAULT;
                                        goto done;
                                }

                                copied++;
                        }
                }
                out_resp->count_enum_blobs = blob_count;
        }
done:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

static struct drm_property_blob *drm_property_create_blob(struct drm_device *dev, int length,
                                                          void *data)
{
        struct drm_property_blob *blob;
        int ret;

        if (!length || !data)
                return NULL;

        blob = malloc(sizeof(struct drm_property_blob)+length, DRM_MEM_KMS,
            M_WAITOK | M_ZERO);
        ret = drm_mode_object_get(dev, &blob->base, DRM_MODE_OBJECT_BLOB);
        if (ret) {
                free(blob, DRM_MEM_KMS);
                return NULL;
        }

        blob->length = length;

        memcpy(blob->data, data, length);

        list_add_tail(&blob->head, &dev->mode_config.property_blob_list);
        return blob;
}

static void drm_property_destroy_blob(struct drm_device *dev,
                               struct drm_property_blob *blob)
{
        drm_mode_object_put(dev, &blob->base);
        list_del(&blob->head);
        free(blob, DRM_MEM_KMS);
}

int drm_mode_getblob_ioctl(struct drm_device *dev,
                           void *data, struct drm_file *file_priv)
{
        struct drm_mode_object *obj;
        struct drm_mode_get_blob *out_resp = data;
        struct drm_property_blob *blob;
        int ret = 0;
        void __user *blob_ptr;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, out_resp->blob_id, DRM_MODE_OBJECT_BLOB);
        if (!obj) {
                ret = -EINVAL;
                goto done;
        }
        blob = obj_to_blob(obj);

        if (out_resp->length == blob->length) {
                blob_ptr = (void __user *)(unsigned long)out_resp->data;
                if (copy_to_user(blob_ptr, blob->data, blob->length)){
                        ret = -EFAULT;
                        goto done;
                }
        }
        out_resp->length = blob->length;

done:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

int drm_mode_connector_update_edid_property(struct drm_connector *connector,
                                            struct edid *edid)
{
        struct drm_device *dev = connector->dev;
        int ret, size;

        if (connector->edid_blob_ptr)
                drm_property_destroy_blob(dev, connector->edid_blob_ptr);

        /* Delete edid, when there is none. */
        if (!edid) {
                connector->edid_blob_ptr = NULL;
                ret = drm_object_property_set_value(&connector->base, dev->mode_config.edid_property, 0);
                return ret;
        }

        size = EDID_LENGTH * (1 + edid->extensions);
        connector->edid_blob_ptr = drm_property_create_blob(connector->dev,
                                                            size, edid);
        if (!connector->edid_blob_ptr)
                return -EINVAL;

        ret = drm_object_property_set_value(&connector->base,
                                               dev->mode_config.edid_property,
                                               connector->edid_blob_ptr->base.id);

        return ret;
}
EXPORT_SYMBOL(drm_mode_connector_update_edid_property);

static bool drm_property_change_is_valid(struct drm_property *property,
                                         uint64_t value)
{
        if (property->flags & DRM_MODE_PROP_IMMUTABLE)
                return false;
        if (property->flags & DRM_MODE_PROP_RANGE) {
                if (value < property->values[0] || value > property->values[1])
                        return false;
                return true;
        } else if (property->flags & DRM_MODE_PROP_BITMASK) {
                int i;
                uint64_t valid_mask = 0;
                for (i = 0; i < property->num_values; i++)
                        valid_mask |= (1ULL << property->values[i]);
                return !(value & ~valid_mask);
        } else if (property->flags & DRM_MODE_PROP_BLOB) {
                /* Only the driver knows */
                return true;
        } else {
                int i;
                for (i = 0; i < property->num_values; i++)
                        if (property->values[i] == value)
                                return true;
                return false;
        }
}

int drm_mode_connector_property_set_ioctl(struct drm_device *dev,
                                       void *data, struct drm_file *file_priv)
{
        struct drm_mode_connector_set_property *conn_set_prop = data;
        struct drm_mode_obj_set_property obj_set_prop = {
                .value = conn_set_prop->value,
                .prop_id = conn_set_prop->prop_id,
                .obj_id = conn_set_prop->connector_id,
                .obj_type = DRM_MODE_OBJECT_CONNECTOR
        };

        /* It does all the locking and checking we need */
        return drm_mode_obj_set_property_ioctl(dev, &obj_set_prop, file_priv);
}

static int drm_mode_connector_set_obj_prop(struct drm_mode_object *obj,
                                           struct drm_property *property,
                                           uint64_t value)
{
        int ret = -EINVAL;
        struct drm_connector *connector = obj_to_connector(obj);

        /* Do DPMS ourselves */
        if (property == connector->dev->mode_config.dpms_property) {
                if (connector->funcs->dpms)
                        (*connector->funcs->dpms)(connector, (int)value);
                ret = 0;
        } else if (connector->funcs->set_property)
                ret = connector->funcs->set_property(connector, property, value);

        /* store the property value if successful */
        if (!ret)
                drm_object_property_set_value(&connector->base, property, value);
        return ret;
}

static int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
                                      struct drm_property *property,
                                      uint64_t value)
{
        int ret = -EINVAL;
        struct drm_crtc *crtc = obj_to_crtc(obj);

        if (crtc->funcs->set_property)
                ret = crtc->funcs->set_property(crtc, property, value);
        if (!ret)
                drm_object_property_set_value(obj, property, value);

        return ret;
}

static int drm_mode_plane_set_obj_prop(struct drm_mode_object *obj,
                                      struct drm_property *property,
                                      uint64_t value)
{
        int ret = -EINVAL;
        struct drm_plane *plane = obj_to_plane(obj);

        if (plane->funcs->set_property)
                ret = plane->funcs->set_property(plane, property, value);
        if (!ret)
                drm_object_property_set_value(obj, property, value);

        return ret;
}

int drm_mode_obj_get_properties_ioctl(struct drm_device *dev, void *data,
                                      struct drm_file *file_priv)
{
        struct drm_mode_obj_get_properties *arg = data;
        struct drm_mode_object *obj;
        int ret = 0;
        int i;
        int copied = 0;
        int props_count = 0;
        uint32_t __user *props_ptr;
        uint64_t __user *prop_values_ptr;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        if (!obj->properties) {
                ret = -EINVAL;
                goto out;
        }

        props_count = obj->properties->count;

        /* This ioctl is called twice, once to determine how much space is
         * needed, and the 2nd time to fill it. */
        if ((arg->count_props >= props_count) && props_count) {
                copied = 0;
                props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
                prop_values_ptr = (uint64_t __user *)(unsigned long)
                                  (arg->prop_values_ptr);
                for (i = 0; i < props_count; i++) {
                        if (put_user(obj->properties->ids[i],
                                     props_ptr + copied)) {
                                ret = -EFAULT;
                                goto out;
                        }
                        if (put_user(obj->properties->values[i],
                                     prop_values_ptr + copied)) {
                                ret = -EFAULT;
                                goto out;
                        }
                        copied++;
                }
        }
        arg->count_props = props_count;
out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

int drm_mode_obj_set_property_ioctl(struct drm_device *dev, void *data,
                                    struct drm_file *file_priv)
{
        struct drm_mode_obj_set_property *arg = data;
        struct drm_mode_object *arg_obj;
        struct drm_mode_object *prop_obj;
        struct drm_property *property;
        int ret = -EINVAL;
        int i;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);

        arg_obj = drm_mode_object_find(dev, arg->obj_id, arg->obj_type);
        if (!arg_obj)
                goto out;
        if (!arg_obj->properties)
                goto out;

        for (i = 0; i < arg_obj->properties->count; i++)
                if (arg_obj->properties->ids[i] == arg->prop_id)
                        break;

        if (i == arg_obj->properties->count)
                goto out;

        prop_obj = drm_mode_object_find(dev, arg->prop_id,
                                        DRM_MODE_OBJECT_PROPERTY);
        if (!prop_obj)
                goto out;
        property = obj_to_property(prop_obj);

        if (!drm_property_change_is_valid(property, arg->value))
                goto out;

        switch (arg_obj->type) {
        case DRM_MODE_OBJECT_CONNECTOR:
                ret = drm_mode_connector_set_obj_prop(arg_obj, property,
                                                      arg->value);
                break;
        case DRM_MODE_OBJECT_CRTC:
                ret = drm_mode_crtc_set_obj_prop(arg_obj, property, arg->value);
                break;
        case DRM_MODE_OBJECT_PLANE:
                ret = drm_mode_plane_set_obj_prop(arg_obj, property, arg->value);
                break;
        }

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

int drm_mode_connector_attach_encoder(struct drm_connector *connector,
                                      struct drm_encoder *encoder)
{
        int i;

        for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
                if (connector->encoder_ids[i] == 0) {
                        connector->encoder_ids[i] = encoder->base.id;
                        return 0;
                }
        }
        return -ENOMEM;
}
EXPORT_SYMBOL(drm_mode_connector_attach_encoder);

void drm_mode_connector_detach_encoder(struct drm_connector *connector,
                                    struct drm_encoder *encoder)
{
        int i;
        for (i = 0; i < DRM_CONNECTOR_MAX_ENCODER; i++) {
                if (connector->encoder_ids[i] == encoder->base.id) {
                        connector->encoder_ids[i] = 0;
                        if (connector->encoder == encoder)
                                connector->encoder = NULL;
                        break;
                }
        }
}
EXPORT_SYMBOL(drm_mode_connector_detach_encoder);

int drm_mode_crtc_set_gamma_size(struct drm_crtc *crtc,
                                  int gamma_size)
{
        crtc->gamma_size = gamma_size;

        crtc->gamma_store = malloc(gamma_size * sizeof(uint16_t) * 3,
            DRM_MEM_KMS, M_WAITOK | M_ZERO);

        return 0;
}
EXPORT_SYMBOL(drm_mode_crtc_set_gamma_size);

int drm_mode_gamma_set_ioctl(struct drm_device *dev,
                             void *data, struct drm_file *file_priv)
{
        struct drm_mode_crtc_lut *crtc_lut = data;
        struct drm_mode_object *obj;
        struct drm_crtc *crtc;
        void *r_base, *g_base, *b_base;
        int size;
        int ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, crtc_lut->crtc_id, DRM_MODE_OBJECT_CRTC);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        crtc = obj_to_crtc(obj);

        if (crtc->funcs->gamma_set == NULL) {
                ret = -ENOSYS;
                goto out;
        }

        /* memcpy into gamma store */
        if (crtc_lut->gamma_size != crtc->gamma_size) {
                ret = -EINVAL;
                goto out;
        }

        size = crtc_lut->gamma_size * (sizeof(uint16_t));
        r_base = crtc->gamma_store;
        if (copy_from_user(r_base, (void __user *)(unsigned long)crtc_lut->red, size)) {
                ret = -EFAULT;
                goto out;
        }

        g_base = (char *)r_base + size;
        if (copy_from_user(g_base, (void __user *)(unsigned long)crtc_lut->green, size)) {
                ret = -EFAULT;
                goto out;
        }

        b_base = (char *)g_base + size;
        if (copy_from_user(b_base, (void __user *)(unsigned long)crtc_lut->blue, size)) {
                ret = -EFAULT;
                goto out;
        }

        crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;

}

int drm_mode_gamma_get_ioctl(struct drm_device *dev,
                             void *data, struct drm_file *file_priv)
{
        struct drm_mode_crtc_lut *crtc_lut = data;
        struct drm_mode_object *obj;
        struct drm_crtc *crtc;
        void *r_base, *g_base, *b_base;
        int size;
        int ret = 0;

        if (!drm_core_check_feature(dev, DRIVER_MODESET))
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, crtc_lut->crtc_id, DRM_MODE_OBJECT_CRTC);
        if (!obj) {
                ret = -EINVAL;
                goto out;
        }
        crtc = obj_to_crtc(obj);

        /* memcpy into gamma store */
        if (crtc_lut->gamma_size != crtc->gamma_size) {
                ret = -EINVAL;
                goto out;
        }

        size = crtc_lut->gamma_size * (sizeof(uint16_t));
        r_base = crtc->gamma_store;
        if (copy_to_user((void __user *)(unsigned long)crtc_lut->red, r_base, size)) {
                ret = -EFAULT;
                goto out;
        }

        g_base = (char *)r_base + size;
        if (copy_to_user((void __user *)(unsigned long)crtc_lut->green, g_base, size)) {
                ret = -EFAULT;
                goto out;
        }

        b_base = (char *)g_base + size;
        if (copy_to_user((void __user *)(unsigned long)crtc_lut->blue, b_base, size)) {
                ret = -EFAULT;
                goto out;
        }
out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

static void
free_vblank_event(void *arg)
{

        free(arg, DRM_MEM_KMS);
}

int drm_mode_page_flip_ioctl(struct drm_device *dev,
                             void *data, struct drm_file *file_priv)
{
        struct drm_mode_crtc_page_flip *page_flip = data;
        struct drm_mode_object *obj;
        struct drm_crtc *crtc;
        struct drm_framebuffer *fb;
        struct drm_pending_vblank_event *e = NULL;
#ifdef __linux__
        unsigned long flags;
#endif
        int hdisplay, vdisplay;
        int ret = -EINVAL;

        if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS ||
            page_flip->reserved != 0)
                return -EINVAL;

        sx_xlock(&dev->mode_config.mutex);
        obj = drm_mode_object_find(dev, page_flip->crtc_id, DRM_MODE_OBJECT_CRTC);
        if (!obj)
                goto out;
        crtc = obj_to_crtc(obj);

        if (crtc->fb == NULL) {
                /* The framebuffer is currently unbound, presumably
                 * due to a hotplug event, that userspace has not
                 * yet discovered.
                 */
                ret = -EBUSY;
                goto out;
        }

        if (crtc->funcs->page_flip == NULL)
                goto out;

        obj = drm_mode_object_find(dev, page_flip->fb_id, DRM_MODE_OBJECT_FB);
        if (!obj)
                goto out;
        fb = obj_to_fb(obj);

        hdisplay = crtc->mode.hdisplay;
        vdisplay = crtc->mode.vdisplay;

        if (crtc->invert_dimensions) {
                int tmp;
                tmp = vdisplay;
                vdisplay = hdisplay;
                hdisplay = tmp;
        }

        if (hdisplay > fb->width ||
            vdisplay > fb->height ||
            crtc->x > fb->width - hdisplay ||
            crtc->y > fb->height - vdisplay) {
                DRM_DEBUG_KMS("Invalid fb size %ux%u for CRTC viewport %ux%u+%d+%d%s.\n",
                              fb->width, fb->height, hdisplay, vdisplay, crtc->x, crtc->y,
                              crtc->invert_dimensions ? " (inverted)" : "");
                ret = -ENOSPC;
                goto out;
        }

        if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
                ret = -ENOMEM;
                mtx_lock(&dev->event_lock);
                if (file_priv->event_space < sizeof e->event) {
                        mtx_unlock(&dev->event_lock);
                        goto out;
                }
                file_priv->event_space -= sizeof e->event;
                mtx_unlock(&dev->event_lock);

                e = malloc(sizeof *e, DRM_MEM_KMS, M_WAITOK | M_ZERO);
                e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
                e->event.base.length = sizeof e->event;
                e->event.user_data = page_flip->user_data;
                e->base.event = &e->event.base;
                e->base.file_priv = file_priv;
                e->base.destroy =
                        (void (*) (struct drm_pending_event *)) free_vblank_event;
        }

        ret = crtc->funcs->page_flip(crtc, fb, e);
        if (ret) {
                if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
                        mtx_lock(&dev->event_lock);
                        file_priv->event_space += sizeof e->event;
                        mtx_unlock(&dev->event_lock);
                        free(e, DRM_MEM_KMS);
                }
        }

out:
        sx_xunlock(&dev->mode_config.mutex);
        return ret;
}

void drm_mode_config_reset(struct drm_device *dev)
{
        struct drm_crtc *crtc;
        struct drm_encoder *encoder;
        struct drm_connector *connector;

        list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
                if (crtc->funcs->reset)
                        crtc->funcs->reset(crtc);

        list_for_each_entry(encoder, &dev->mode_config.encoder_list, head)
                if (encoder->funcs->reset)
                        encoder->funcs->reset(encoder);

        list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
                connector->status = connector_status_unknown;

                if (connector->funcs->reset)
                        connector->funcs->reset(connector);
        }
}
EXPORT_SYMBOL(drm_mode_config_reset);

int drm_mode_create_dumb_ioctl(struct drm_device *dev,
                               void *data, struct drm_file *file_priv)
{
        struct drm_mode_create_dumb *args = data;

        if (!dev->driver->dumb_create)
                return -ENOSYS;
        return dev->driver->dumb_create(file_priv, dev, args);
}

int drm_mode_mmap_dumb_ioctl(struct drm_device *dev,
                             void *data, struct drm_file *file_priv)
{
        struct drm_mode_map_dumb *args = data;

        /* call driver ioctl to get mmap offset */
        if (!dev->driver->dumb_map_offset)
                return -ENOSYS;

        return dev->driver->dumb_map_offset(file_priv, dev, args->handle, &args->offset);
}

int drm_mode_destroy_dumb_ioctl(struct drm_device *dev,
                                void *data, struct drm_file *file_priv)
{
        struct drm_mode_destroy_dumb *args = data;

        if (!dev->driver->dumb_destroy)
                return -ENOSYS;

        return dev->driver->dumb_destroy(file_priv, dev, args->handle);
}

/*
 * Just need to support RGB formats here for compat with code that doesn't
 * use pixel formats directly yet.
 */
void drm_fb_get_bpp_depth(uint32_t format, unsigned int *depth,
                          int *bpp)
{
        switch (format) {
        case DRM_FORMAT_C8:
        case DRM_FORMAT_RGB332:
        case DRM_FORMAT_BGR233:
                *depth = 8;
                *bpp = 8;
                break;
        case DRM_FORMAT_XRGB1555:
        case DRM_FORMAT_XBGR1555:
        case DRM_FORMAT_RGBX5551:
        case DRM_FORMAT_BGRX5551:
        case DRM_FORMAT_ARGB1555:
        case DRM_FORMAT_ABGR1555:
        case DRM_FORMAT_RGBA5551:
        case DRM_FORMAT_BGRA5551:
                *depth = 15;
                *bpp = 16;
                break;
        case DRM_FORMAT_RGB565:
        case DRM_FORMAT_BGR565:
                *depth = 16;
                *bpp = 16;
                break;
        case DRM_FORMAT_RGB888:
        case DRM_FORMAT_BGR888:
                *depth = 24;
                *bpp = 24;
                break;
        case DRM_FORMAT_XRGB8888:
        case DRM_FORMAT_XBGR8888:
        case DRM_FORMAT_RGBX8888:
        case DRM_FORMAT_BGRX8888:
                *depth = 24;
                *bpp = 32;
                break;
        case DRM_FORMAT_XRGB2101010:
        case DRM_FORMAT_XBGR2101010:
        case DRM_FORMAT_RGBX1010102:
        case DRM_FORMAT_BGRX1010102:
        case DRM_FORMAT_ARGB2101010:
        case DRM_FORMAT_ABGR2101010:
        case DRM_FORMAT_RGBA1010102:
        case DRM_FORMAT_BGRA1010102:
                *depth = 30;
                *bpp = 32;
                break;
        case DRM_FORMAT_ARGB8888:
        case DRM_FORMAT_ABGR8888:
        case DRM_FORMAT_RGBA8888:
        case DRM_FORMAT_BGRA8888:
                *depth = 32;
                *bpp = 32;
                break;
        default:
                DRM_DEBUG_KMS("unsupported pixel format\n");
                *depth = 0;
                *bpp = 0;
                break;
        }
}
EXPORT_SYMBOL(drm_fb_get_bpp_depth);

/**
 * drm_format_num_planes - get the number of planes for format
 * @format: pixel format (DRM_FORMAT_*)
 *
 * RETURNS:
 * The number of planes used by the specified pixel format.
 */
int drm_format_num_planes(uint32_t format)
{
        switch (format) {
        case DRM_FORMAT_YUV410:
        case DRM_FORMAT_YVU410:
        case DRM_FORMAT_YUV411:
        case DRM_FORMAT_YVU411:
        case DRM_FORMAT_YUV420:
        case DRM_FORMAT_YVU420:
        case DRM_FORMAT_YUV422:
        case DRM_FORMAT_YVU422:
        case DRM_FORMAT_YUV444:
        case DRM_FORMAT_YVU444:
                return 3;
        case DRM_FORMAT_NV12:
        case DRM_FORMAT_NV21:
        case DRM_FORMAT_NV16:
        case DRM_FORMAT_NV61:
        case DRM_FORMAT_NV24:
        case DRM_FORMAT_NV42:
                return 2;
        default:
                return 1;
        }
}
EXPORT_SYMBOL(drm_format_num_planes);

/**
 * drm_format_plane_cpp - determine the bytes per pixel value
 * @format: pixel format (DRM_FORMAT_*)
 * @plane: plane index
 *
 * RETURNS:
 * The bytes per pixel value for the specified plane.
 */
int drm_format_plane_cpp(uint32_t format, int plane)
{
        unsigned int depth;
        int bpp;

        if (plane >= drm_format_num_planes(format))
                return 0;

        switch (format) {
        case DRM_FORMAT_YUYV:
        case DRM_FORMAT_YVYU:
        case DRM_FORMAT_UYVY:
        case DRM_FORMAT_VYUY:
                return 2;
        case DRM_FORMAT_NV12:
        case DRM_FORMAT_NV21:
        case DRM_FORMAT_NV16:
        case DRM_FORMAT_NV61:
        case DRM_FORMAT_NV24:
        case DRM_FORMAT_NV42:
                return plane ? 2 : 1;
        case DRM_FORMAT_YUV410:
        case DRM_FORMAT_YVU410:
        case DRM_FORMAT_YUV411:
        case DRM_FORMAT_YVU411:
        case DRM_FORMAT_YUV420:
        case DRM_FORMAT_YVU420:
        case DRM_FORMAT_YUV422:
        case DRM_FORMAT_YVU422:
        case DRM_FORMAT_YUV444:
        case DRM_FORMAT_YVU444:
                return 1;
        default:
                drm_fb_get_bpp_depth(format, &depth, &bpp);
                return bpp >> 3;
        }
}
EXPORT_SYMBOL(drm_format_plane_cpp);

/**
 * drm_format_horz_chroma_subsampling - get the horizontal chroma subsampling factor
 * @format: pixel format (DRM_FORMAT_*)
 *
 * RETURNS:
 * The horizontal chroma subsampling factor for the
 * specified pixel format.
 */
int drm_format_horz_chroma_subsampling(uint32_t format)
{
        switch (format) {
        case DRM_FORMAT_YUV411:
        case DRM_FORMAT_YVU411:
        case DRM_FORMAT_YUV410:
        case DRM_FORMAT_YVU410:
                return 4;
        case DRM_FORMAT_YUYV:
        case DRM_FORMAT_YVYU:
        case DRM_FORMAT_UYVY:
        case DRM_FORMAT_VYUY:
        case DRM_FORMAT_NV12:
        case DRM_FORMAT_NV21:
        case DRM_FORMAT_NV16:
        case DRM_FORMAT_NV61:
        case DRM_FORMAT_YUV422:
        case DRM_FORMAT_YVU422:
        case DRM_FORMAT_YUV420:
        case DRM_FORMAT_YVU420:
                return 2;
        default:
                return 1;
        }
}
EXPORT_SYMBOL(drm_format_horz_chroma_subsampling);

/**
 * drm_format_vert_chroma_subsampling - get the vertical chroma subsampling factor
 * @format: pixel format (DRM_FORMAT_*)
 *
 * RETURNS:
 * The vertical chroma subsampling factor for the
 * specified pixel format.
 */
int drm_format_vert_chroma_subsampling(uint32_t format)
{
        switch (format) {
        case DRM_FORMAT_YUV410:
        case DRM_FORMAT_YVU410:
                return 4;
        case DRM_FORMAT_YUV420:
        case DRM_FORMAT_YVU420:
        case DRM_FORMAT_NV12:
        case DRM_FORMAT_NV21:
                return 2;
        default:
                return 1;
        }
}
EXPORT_SYMBOL(drm_format_vert_chroma_subsampling);