/* qxl_drv.c -- QXL driver -*- linux-c -*-
 *
 * Copyright 2011 Red Hat, Inc.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Authors:
 *    Dave Airlie <airlie@redhat.com>
 *    Alon Levy <alevy@redhat.com>
 */

#include "qxl_drv.h"

#include <linux/aperture.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/vgaarb.h>

#include <drm/clients/drm_client_setup.h>
#include <drm/drm.h>
#include <drm/drm_atomic_helper.h>
#include <drm/drm_drv.h>
#include <drm/drm_fbdev_ttm.h>
#include <drm/drm_file.h>
#include <drm/drm_gem_ttm_helper.h>
#include <drm/drm_module.h>
#include <drm/drm_modeset_helper.h>
#include <drm/drm_prime.h>
#include <drm/drm_print.h>
#include <drm/drm_probe_helper.h>

#include "qxl_object.h"

static const struct pci_device_id pciidlist[] = {
        { 0x1b36, 0x100, PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_DISPLAY_VGA << 8,
          0xffff00, 0 },
        { 0x1b36, 0x100, PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_DISPLAY_OTHER << 8,
          0xffff00, 0 },
        { 0, 0, 0 },
};
MODULE_DEVICE_TABLE(pci, pciidlist);

static int qxl_modeset = -1;
int qxl_num_crtc = 4;

MODULE_PARM_DESC(modeset, "Disable/Enable modesetting");
module_param_named(modeset, qxl_modeset, int, 0400);

MODULE_PARM_DESC(num_heads, "Number of virtual crtcs to expose (default 4)");
module_param_named(num_heads, qxl_num_crtc, int, 0400);

static struct drm_driver qxl_driver;
static struct pci_driver qxl_pci_driver;

static int
qxl_pci_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
{
        struct qxl_device *qdev;
        int ret;

        if (pdev->revision < 4) {
                DRM_ERROR("qxl too old, doesn't support client_monitors_config,"
                          " use xf86-video-qxl in user mode");
                return -EINVAL; /* TODO: ENODEV ? */
        }

        qdev = devm_drm_dev_alloc(&pdev->dev, &qxl_driver,
                                  struct qxl_device, ddev);
        if (IS_ERR(qdev)) {
                pr_err("Unable to init drm dev");
                return -ENOMEM;
        }

        ret = pci_enable_device(pdev);
        if (ret)
                return ret;

        ret = aperture_remove_conflicting_pci_devices(pdev, qxl_driver.name);
        if (ret)
                goto disable_pci;

        if (pci_is_vga(pdev) && pdev->revision < 5) {
                ret = vga_get_interruptible(pdev, VGA_RSRC_LEGACY_IO);
                if (ret) {
                        DRM_ERROR("can't get legacy vga ioports\n");
                        goto disable_pci;
                }
        }

        ret = qxl_device_init(qdev, pdev);
        if (ret)
                goto put_vga;

        ret = qxl_modeset_init(qdev);
        if (ret)
                goto unload;

        drm_kms_helper_poll_init(&qdev->ddev);

        /* Complete initialization. */
        ret = drm_dev_register(&qdev->ddev, ent->driver_data);
        if (ret)
                goto modeset_cleanup;

        drm_client_setup(&qdev->ddev, NULL);
        return 0;

modeset_cleanup:
        qxl_modeset_fini(qdev);
unload:
        qxl_device_fini(qdev);
put_vga:
        if (pci_is_vga(pdev) && pdev->revision < 5)
                vga_put(pdev, VGA_RSRC_LEGACY_IO);
disable_pci:
        pci_disable_device(pdev);

        return ret;
}

static void qxl_drm_release(struct drm_device *dev)
{
        struct qxl_device *qdev = to_qxl(dev);

        /*
         * TODO: qxl_device_fini() call should be in qxl_pci_remove(),
         * reordering qxl_modeset_fini() + qxl_device_fini() calls is
         * non-trivial though.
         */
        qxl_modeset_fini(qdev);
        qxl_device_fini(qdev);
}

static void
qxl_pci_remove(struct pci_dev *pdev)
{
        struct drm_device *dev = pci_get_drvdata(pdev);

        drm_dev_unregister(dev);
        drm_atomic_helper_shutdown(dev);
        if (pci_is_vga(pdev) && pdev->revision < 5)
                vga_put(pdev, VGA_RSRC_LEGACY_IO);
}

static void
qxl_pci_shutdown(struct pci_dev *pdev)
{
        drm_atomic_helper_shutdown(pci_get_drvdata(pdev));
}

DEFINE_DRM_GEM_FOPS(qxl_fops);

static int qxl_drm_freeze(struct drm_device *dev)
{
        struct pci_dev *pdev = to_pci_dev(dev->dev);
        struct qxl_device *qdev = to_qxl(dev);
        int ret;

        ret = drm_mode_config_helper_suspend(dev);
        if (ret)
                return ret;

        qxl_destroy_monitors_object(qdev);
        qxl_surf_evict(qdev);
        qxl_vram_evict(qdev);

        while (!qxl_check_idle(qdev->command_ring));
        while (!qxl_check_idle(qdev->release_ring))
                qxl_queue_garbage_collect(qdev, 1);

        pci_save_state(pdev);

        return 0;
}

static int qxl_drm_resume(struct drm_device *dev, bool thaw)
{
        struct qxl_device *qdev = to_qxl(dev);

        qdev->ram_header->int_mask = QXL_INTERRUPT_MASK;
        if (!thaw) {
                qxl_reinit_memslots(qdev);
        }

        qxl_create_monitors_object(qdev);
        return drm_mode_config_helper_resume(dev);
}

static int qxl_pm_suspend(struct device *dev)
{
        struct pci_dev *pdev = to_pci_dev(dev);
        struct drm_device *drm_dev = pci_get_drvdata(pdev);
        int error;

        error = qxl_drm_freeze(drm_dev);
        if (error)
                return error;

        pci_disable_device(pdev);
        pci_set_power_state(pdev, PCI_D3hot);
        return 0;
}

static int qxl_pm_resume(struct device *dev)
{
        struct pci_dev *pdev = to_pci_dev(dev);
        struct drm_device *drm_dev = pci_get_drvdata(pdev);
        struct qxl_device *qdev = to_qxl(drm_dev);

        pci_set_power_state(pdev, PCI_D0);
        pci_restore_state(pdev);
        if (pci_enable_device(pdev)) {
                return -EIO;
        }

        qxl_io_reset(qdev);
        return qxl_drm_resume(drm_dev, false);
}

static int qxl_pm_thaw(struct device *dev)
{
        struct drm_device *drm_dev = dev_get_drvdata(dev);

        return qxl_drm_resume(drm_dev, true);
}

static int qxl_pm_freeze(struct device *dev)
{
        struct drm_device *drm_dev = dev_get_drvdata(dev);

        return qxl_drm_freeze(drm_dev);
}

static int qxl_pm_restore(struct device *dev)
{
        struct pci_dev *pdev = to_pci_dev(dev);
        struct drm_device *drm_dev = pci_get_drvdata(pdev);
        struct qxl_device *qdev = to_qxl(drm_dev);

        qxl_io_reset(qdev);
        return qxl_drm_resume(drm_dev, false);
}

static const struct dev_pm_ops qxl_pm_ops = {
        .suspend = qxl_pm_suspend,
        .resume = qxl_pm_resume,
        .freeze = qxl_pm_freeze,
        .thaw = qxl_pm_thaw,
        .poweroff = qxl_pm_freeze,
        .restore = qxl_pm_restore,
};
static struct pci_driver qxl_pci_driver = {
         .name = DRIVER_NAME,
         .id_table = pciidlist,
         .probe = qxl_pci_probe,
         .remove = qxl_pci_remove,
         .shutdown = qxl_pci_shutdown,
         .driver.pm = &qxl_pm_ops,
};

static const struct drm_ioctl_desc qxl_ioctls[] = {
        DRM_IOCTL_DEF_DRV(QXL_ALLOC, qxl_alloc_ioctl, DRM_AUTH),
        DRM_IOCTL_DEF_DRV(QXL_MAP, qxl_map_ioctl, DRM_AUTH),
        DRM_IOCTL_DEF_DRV(QXL_EXECBUFFER, qxl_execbuffer_ioctl, DRM_AUTH),
        DRM_IOCTL_DEF_DRV(QXL_UPDATE_AREA, qxl_update_area_ioctl, DRM_AUTH),
        DRM_IOCTL_DEF_DRV(QXL_GETPARAM, qxl_getparam_ioctl, DRM_AUTH),
        DRM_IOCTL_DEF_DRV(QXL_CLIENTCAP, qxl_clientcap_ioctl, DRM_AUTH),
        DRM_IOCTL_DEF_DRV(QXL_ALLOC_SURF, qxl_alloc_surf_ioctl, DRM_AUTH),
};

static struct drm_driver qxl_driver = {
        .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC | DRIVER_CURSOR_HOTSPOT,

        .dumb_create = qxl_mode_dumb_create,
        .dumb_map_offset = drm_gem_ttm_dumb_map_offset,
#if defined(CONFIG_DEBUG_FS)
        .debugfs_init = qxl_debugfs_init,
#endif
        .gem_prime_import_sg_table = qxl_gem_prime_import_sg_table,
        DRM_FBDEV_TTM_DRIVER_OPS,
        .fops = &qxl_fops,
        .ioctls = qxl_ioctls,
        .num_ioctls = ARRAY_SIZE(qxl_ioctls),
        .name = DRIVER_NAME,
        .desc = DRIVER_DESC,
        .major = 0,
        .minor = 1,
        .patchlevel = 0,

        .release = qxl_drm_release,
};

drm_module_pci_driver_if_modeset(qxl_pci_driver, qxl_modeset);

MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_LICENSE("GPL and additional rights");