/*
 * Copyright 2013 Red Hat Inc.
 *
 * 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 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
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) 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
 *          Alon Levy
 */

#include <linux/delay.h>

#include <drm/drm.h>
#include <drm/drm_file.h>
#include <drm/drm_debugfs.h>
#include <drm/drm_print.h>
#include <drm/qxl_drm.h>
#include <drm/ttm/ttm_bo.h>
#include <drm/ttm/ttm_placement.h>
#include <drm/ttm/ttm_range_manager.h>
#include <drm/ttm/ttm_tt.h>

#include "qxl_drv.h"
#include "qxl_object.h"

static struct qxl_device *qxl_get_qdev(struct ttm_device *bdev)
{
        struct qxl_mman *mman;
        struct qxl_device *qdev;

        mman = container_of(bdev, struct qxl_mman, bdev);
        qdev = container_of(mman, struct qxl_device, mman);
        return qdev;
}

static void qxl_evict_flags(struct ttm_buffer_object *bo,
                                struct ttm_placement *placement)
{
        struct qxl_bo *qbo;
        static const struct ttm_place placements = {
                .fpfn = 0,
                .lpfn = 0,
                .mem_type = TTM_PL_SYSTEM,
                .flags = 0
        };

        if (!qxl_ttm_bo_is_qxl_bo(bo)) {
                placement->placement = &placements;
                placement->num_placement = 1;
                return;
        }
        qbo = to_qxl_bo(bo);
        qxl_ttm_placement_from_domain(qbo, QXL_GEM_DOMAIN_CPU);
        *placement = qbo->placement;
}

int qxl_ttm_io_mem_reserve(struct ttm_device *bdev,
                           struct ttm_resource *mem)
{
        struct qxl_device *qdev = qxl_get_qdev(bdev);

        switch (mem->mem_type) {
        case TTM_PL_SYSTEM:
                /* system memory */
                return 0;
        case TTM_PL_VRAM:
                mem->bus.is_iomem = true;
                mem->bus.offset = (mem->start << PAGE_SHIFT) + qdev->vram_base;
                mem->bus.caching = ttm_write_combined;
                break;
        case TTM_PL_PRIV:
                mem->bus.is_iomem = true;
                mem->bus.offset = (mem->start << PAGE_SHIFT) +
                        qdev->surfaceram_base;
                mem->bus.caching = ttm_write_combined;
                break;
        default:
                return -EINVAL;
        }
        return 0;
}

/*
 * TTM backend functions.
 */
static void qxl_ttm_backend_destroy(struct ttm_device *bdev, struct ttm_tt *ttm)
{
        ttm_tt_fini(ttm);
        kfree(ttm);
}

static struct ttm_tt *qxl_ttm_tt_create(struct ttm_buffer_object *bo,
                                        uint32_t page_flags)
{
        struct ttm_tt *ttm;

        ttm = kzalloc_obj(struct ttm_tt);
        if (ttm == NULL)
                return NULL;
        if (ttm_tt_init(ttm, bo, page_flags, ttm_cached, 0)) {
                kfree(ttm);
                return NULL;
        }
        return ttm;
}

static void qxl_bo_move_notify(struct ttm_buffer_object *bo,
                               struct ttm_resource *new_mem)
{
        struct qxl_bo *qbo;
        struct qxl_device *qdev;

        if (!qxl_ttm_bo_is_qxl_bo(bo) || !bo->resource)
                return;
        qbo = to_qxl_bo(bo);
        qdev = to_qxl(qbo->tbo.base.dev);

        if (bo->resource->mem_type == TTM_PL_PRIV && qbo->surface_id)
                qxl_surface_evict(qdev, qbo, new_mem ? true : false);
}

static int qxl_bo_move(struct ttm_buffer_object *bo, bool evict,
                       struct ttm_operation_ctx *ctx,
                       struct ttm_resource *new_mem,
                       struct ttm_place *hop)
{
        struct ttm_resource *old_mem = bo->resource;
        int ret;

        if (!old_mem) {
                if (new_mem->mem_type != TTM_PL_SYSTEM) {
                        hop->mem_type = TTM_PL_SYSTEM;
                        hop->flags = TTM_PL_FLAG_TEMPORARY;
                        return -EMULTIHOP;
                }

                ttm_bo_move_null(bo, new_mem);
                return 0;
        }

        qxl_bo_move_notify(bo, new_mem);

        ret = ttm_bo_wait_ctx(bo, ctx);
        if (ret)
                return ret;

        if (old_mem->mem_type == TTM_PL_SYSTEM && bo->ttm == NULL) {
                ttm_bo_move_null(bo, new_mem);
                return 0;
        }
        return ttm_bo_move_memcpy(bo, ctx, new_mem);
}

static void qxl_bo_delete_mem_notify(struct ttm_buffer_object *bo)
{
        qxl_bo_move_notify(bo, NULL);
}

static struct ttm_device_funcs qxl_bo_driver = {
        .ttm_tt_create = &qxl_ttm_tt_create,
        .ttm_tt_destroy = &qxl_ttm_backend_destroy,
        .eviction_valuable = ttm_bo_eviction_valuable,
        .evict_flags = &qxl_evict_flags,
        .move = &qxl_bo_move,
        .io_mem_reserve = &qxl_ttm_io_mem_reserve,
        .delete_mem_notify = &qxl_bo_delete_mem_notify,
};

static int qxl_ttm_init_mem_type(struct qxl_device *qdev,
                                 unsigned int type,
                                 uint64_t size)
{
        return ttm_range_man_init(&qdev->mman.bdev, type, false, size);
}

int qxl_ttm_init(struct qxl_device *qdev)
{
        int r;
        int num_io_pages; /* != rom->num_io_pages, we include surface0 */

        /* No others user of address space so set it to 0 */
        r = ttm_device_init(&qdev->mman.bdev, &qxl_bo_driver, NULL,
                            qdev->ddev.anon_inode->i_mapping,
                            qdev->ddev.vma_offset_manager,
                            0);
        if (r) {
                DRM_ERROR("failed initializing buffer object driver(%d).\n", r);
                return r;
        }
        /* NOTE: this includes the framebuffer (aka surface 0) */
        num_io_pages = qdev->rom->ram_header_offset / PAGE_SIZE;
        r = qxl_ttm_init_mem_type(qdev, TTM_PL_VRAM, num_io_pages);
        if (r) {
                DRM_ERROR("Failed initializing VRAM heap.\n");
                return r;
        }
        r = qxl_ttm_init_mem_type(qdev, TTM_PL_PRIV,
                                  qdev->surfaceram_size / PAGE_SIZE);
        if (r) {
                DRM_ERROR("Failed initializing Surfaces heap.\n");
                return r;
        }
        DRM_INFO("qxl: %uM of VRAM memory size\n",
                 (unsigned int)qdev->vram_size / (1024 * 1024));
        DRM_INFO("qxl: %luM of IO pages memory ready (VRAM domain)\n",
                 ((unsigned int)num_io_pages * PAGE_SIZE) / (1024 * 1024));
        DRM_INFO("qxl: %uM of Surface memory size\n",
                 (unsigned int)qdev->surfaceram_size / (1024 * 1024));
        return 0;
}

void qxl_ttm_fini(struct qxl_device *qdev)
{
        ttm_range_man_fini(&qdev->mman.bdev, TTM_PL_VRAM);
        ttm_range_man_fini(&qdev->mman.bdev, TTM_PL_PRIV);
        ttm_device_fini(&qdev->mman.bdev);
        DRM_INFO("qxl: ttm finalized\n");
}

void qxl_ttm_debugfs_init(struct qxl_device *qdev)
{
#if defined(CONFIG_DEBUG_FS)
        ttm_resource_manager_create_debugfs(ttm_manager_type(&qdev->mman.bdev,
                                                             TTM_PL_VRAM),
                                            qdev->ddev.primary->debugfs_root, "qxl_mem_mm");
        ttm_resource_manager_create_debugfs(ttm_manager_type(&qdev->mman.bdev,
                                                             TTM_PL_PRIV),
                                            qdev->ddev.primary->debugfs_root, "qxl_surf_mm");
#endif
}