/*
 * Copyright 2014 Advanced Micro Devices, 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: Christian König <christian.koenig@amd.com>
 */

#include <linux/delay.h>
#include <linux/firmware.h>

#include "amdgpu.h"
#include "amdgpu_uvd.h"
#include "vid.h"
#include "uvd/uvd_5_0_d.h"
#include "uvd/uvd_5_0_sh_mask.h"
#include "oss/oss_2_0_d.h"
#include "oss/oss_2_0_sh_mask.h"
#include "bif/bif_5_0_d.h"
#include "vi.h"
#include "smu/smu_7_1_2_d.h"
#include "smu/smu_7_1_2_sh_mask.h"
#include "ivsrcid/ivsrcid_vislands30.h"

static void uvd_v5_0_set_ring_funcs(struct amdgpu_device *adev);
static void uvd_v5_0_set_irq_funcs(struct amdgpu_device *adev);
static int uvd_v5_0_start(struct amdgpu_device *adev);
static void uvd_v5_0_stop(struct amdgpu_device *adev);
static int uvd_v5_0_set_clockgating_state(struct amdgpu_ip_block *ip_block,
                                          enum amd_clockgating_state state);
static void uvd_v5_0_enable_mgcg(struct amdgpu_device *adev,
                                 bool enable);
/**
 * uvd_v5_0_ring_get_rptr - get read pointer
 *
 * @ring: amdgpu_ring pointer
 *
 * Returns the current hardware read pointer
 */
static uint64_t uvd_v5_0_ring_get_rptr(struct amdgpu_ring *ring)
{
        struct amdgpu_device *adev = ring->adev;

        return RREG32(mmUVD_RBC_RB_RPTR);
}

/**
 * uvd_v5_0_ring_get_wptr - get write pointer
 *
 * @ring: amdgpu_ring pointer
 *
 * Returns the current hardware write pointer
 */
static uint64_t uvd_v5_0_ring_get_wptr(struct amdgpu_ring *ring)
{
        struct amdgpu_device *adev = ring->adev;

        return RREG32(mmUVD_RBC_RB_WPTR);
}

/**
 * uvd_v5_0_ring_set_wptr - set write pointer
 *
 * @ring: amdgpu_ring pointer
 *
 * Commits the write pointer to the hardware
 */
static void uvd_v5_0_ring_set_wptr(struct amdgpu_ring *ring)
{
        struct amdgpu_device *adev = ring->adev;

        WREG32(mmUVD_RBC_RB_WPTR, lower_32_bits(ring->wptr));
}

static int uvd_v5_0_early_init(struct amdgpu_ip_block *ip_block)
{
        struct amdgpu_device *adev = ip_block->adev;
        adev->uvd.num_uvd_inst = 1;

        uvd_v5_0_set_ring_funcs(adev);
        uvd_v5_0_set_irq_funcs(adev);

        return 0;
}

static int uvd_v5_0_sw_init(struct amdgpu_ip_block *ip_block)
{
        struct amdgpu_ring *ring;
        struct amdgpu_device *adev = ip_block->adev;
        int r;

        /* UVD TRAP */
        r = amdgpu_irq_add_id(adev, AMDGPU_IRQ_CLIENTID_LEGACY, VISLANDS30_IV_SRCID_UVD_SYSTEM_MESSAGE, &adev->uvd.inst->irq);
        if (r)
                return r;

        r = amdgpu_uvd_sw_init(adev);
        if (r)
                return r;

        ring = &adev->uvd.inst->ring;
        snprintf(ring->name, sizeof(ring->name), "uvd");
        r = amdgpu_ring_init(adev, ring, 512, &adev->uvd.inst->irq, 0,
                             AMDGPU_RING_PRIO_DEFAULT, NULL);
        if (r)
                return r;

        r = amdgpu_uvd_resume(adev);
        if (r)
                return r;

        return r;
}

static int uvd_v5_0_sw_fini(struct amdgpu_ip_block *ip_block)
{
        int r;
        struct amdgpu_device *adev = ip_block->adev;

        r = amdgpu_uvd_suspend(adev);
        if (r)
                return r;

        return amdgpu_uvd_sw_fini(adev);
}

/**
 * uvd_v5_0_hw_init - start and test UVD block
 *
 * @ip_block: Pointer to the amdgpu_ip_block for this hw instance.
 *
 * Initialize the hardware, boot up the VCPU and do some testing
 */
static int uvd_v5_0_hw_init(struct amdgpu_ip_block *ip_block)
{
        struct amdgpu_device *adev = ip_block->adev;
        struct amdgpu_ring *ring = &adev->uvd.inst->ring;
        uint32_t tmp;
        int r;

        amdgpu_asic_set_uvd_clocks(adev, 10000, 10000);
        uvd_v5_0_set_clockgating_state(ip_block, AMD_CG_STATE_UNGATE);
        uvd_v5_0_enable_mgcg(adev, true);

        r = amdgpu_ring_test_helper(ring);
        if (r)
                goto done;

        r = amdgpu_ring_alloc(ring, 10);
        if (r) {
                DRM_ERROR("amdgpu: ring failed to lock UVD ring (%d).\n", r);
                goto done;
        }

        tmp = PACKET0(mmUVD_SEMA_WAIT_FAULT_TIMEOUT_CNTL, 0);
        amdgpu_ring_write(ring, tmp);
        amdgpu_ring_write(ring, 0xFFFFF);

        tmp = PACKET0(mmUVD_SEMA_WAIT_INCOMPLETE_TIMEOUT_CNTL, 0);
        amdgpu_ring_write(ring, tmp);
        amdgpu_ring_write(ring, 0xFFFFF);

        tmp = PACKET0(mmUVD_SEMA_SIGNAL_INCOMPLETE_TIMEOUT_CNTL, 0);
        amdgpu_ring_write(ring, tmp);
        amdgpu_ring_write(ring, 0xFFFFF);

        /* Clear timeout status bits */
        amdgpu_ring_write(ring, PACKET0(mmUVD_SEMA_TIMEOUT_STATUS, 0));
        amdgpu_ring_write(ring, 0x8);

        amdgpu_ring_write(ring, PACKET0(mmUVD_SEMA_CNTL, 0));
        amdgpu_ring_write(ring, 3);

        amdgpu_ring_commit(ring);

done:
        if (!r)
                DRM_INFO("UVD initialized successfully.\n");

        return r;

}

/**
 * uvd_v5_0_hw_fini - stop the hardware block
 *
 * @ip_block: Pointer to the amdgpu_ip_block for this hw instance.
 *
 * Stop the UVD block, mark ring as not ready any more
 */
static int uvd_v5_0_hw_fini(struct amdgpu_ip_block *ip_block)
{
        struct amdgpu_device *adev = ip_block->adev;

        cancel_delayed_work_sync(&adev->uvd.idle_work);

        if (RREG32(mmUVD_STATUS) != 0)
                uvd_v5_0_stop(adev);

        return 0;
}

static int uvd_v5_0_prepare_suspend(struct amdgpu_ip_block *ip_block)
{
        struct amdgpu_device *adev = ip_block->adev;

        return amdgpu_uvd_prepare_suspend(adev);
}

static int uvd_v5_0_suspend(struct amdgpu_ip_block *ip_block)
{
        int r;
        struct amdgpu_device *adev = ip_block->adev;

        /*
         * Proper cleanups before halting the HW engine:
         *   - cancel the delayed idle work
         *   - enable powergating
         *   - enable clockgating
         *   - disable dpm
         *
         * TODO: to align with the VCN implementation, move the
         * jobs for clockgating/powergating/dpm setting to
         * ->set_powergating_state().
         */
        cancel_delayed_work_sync(&adev->uvd.idle_work);

        if (adev->pm.dpm_enabled) {
                amdgpu_dpm_enable_uvd(adev, false);
        } else {
                amdgpu_asic_set_uvd_clocks(adev, 0, 0);
                /* shutdown the UVD block */
                amdgpu_device_ip_set_powergating_state(adev, AMD_IP_BLOCK_TYPE_UVD,
                                                       AMD_PG_STATE_GATE);
                amdgpu_device_ip_set_clockgating_state(adev, AMD_IP_BLOCK_TYPE_UVD,
                                                       AMD_CG_STATE_GATE);
        }

        r = uvd_v5_0_hw_fini(ip_block);
        if (r)
                return r;

        return amdgpu_uvd_suspend(adev);
}

static int uvd_v5_0_resume(struct amdgpu_ip_block *ip_block)
{
        int r;

        r = amdgpu_uvd_resume(ip_block->adev);
        if (r)
                return r;

        return uvd_v5_0_hw_init(ip_block);
}

/**
 * uvd_v5_0_mc_resume - memory controller programming
 *
 * @adev: amdgpu_device pointer
 *
 * Let the UVD memory controller know it's offsets
 */
static void uvd_v5_0_mc_resume(struct amdgpu_device *adev)
{
        uint64_t offset;
        uint32_t size;

        /* program memory controller bits 0-27 */
        WREG32(mmUVD_LMI_VCPU_CACHE_64BIT_BAR_LOW,
                        lower_32_bits(adev->uvd.inst->gpu_addr));
        WREG32(mmUVD_LMI_VCPU_CACHE_64BIT_BAR_HIGH,
                        upper_32_bits(adev->uvd.inst->gpu_addr));

        offset = AMDGPU_UVD_FIRMWARE_OFFSET;
        size = AMDGPU_UVD_FIRMWARE_SIZE(adev);
        WREG32(mmUVD_VCPU_CACHE_OFFSET0, offset >> 3);
        WREG32(mmUVD_VCPU_CACHE_SIZE0, size);

        offset += size;
        size = AMDGPU_UVD_HEAP_SIZE;
        WREG32(mmUVD_VCPU_CACHE_OFFSET1, offset >> 3);
        WREG32(mmUVD_VCPU_CACHE_SIZE1, size);

        offset += size;
        size = AMDGPU_UVD_STACK_SIZE +
               (AMDGPU_UVD_SESSION_SIZE * adev->uvd.max_handles);
        WREG32(mmUVD_VCPU_CACHE_OFFSET2, offset >> 3);
        WREG32(mmUVD_VCPU_CACHE_SIZE2, size);

        WREG32(mmUVD_UDEC_ADDR_CONFIG, adev->gfx.config.gb_addr_config);
        WREG32(mmUVD_UDEC_DB_ADDR_CONFIG, adev->gfx.config.gb_addr_config);
        WREG32(mmUVD_UDEC_DBW_ADDR_CONFIG, adev->gfx.config.gb_addr_config);
}

/**
 * uvd_v5_0_start - start UVD block
 *
 * @adev: amdgpu_device pointer
 *
 * Setup and start the UVD block
 */
static int uvd_v5_0_start(struct amdgpu_device *adev)
{
        struct amdgpu_ring *ring = &adev->uvd.inst->ring;
        uint32_t rb_bufsz, tmp;
        uint32_t lmi_swap_cntl;
        uint32_t mp_swap_cntl;
        int i, j, r;

        /*disable DPG */
        WREG32_P(mmUVD_POWER_STATUS, 0, ~(1 << 2));

        /* disable byte swapping */
        lmi_swap_cntl = 0;
        mp_swap_cntl = 0;

        uvd_v5_0_mc_resume(adev);

        /* disable interupt */
        WREG32_P(mmUVD_MASTINT_EN, 0, ~(1 << 1));

        /* stall UMC and register bus before resetting VCPU */
        WREG32_P(mmUVD_LMI_CTRL2, 1 << 8, ~(1 << 8));
        mdelay(1);

        /* put LMI, VCPU, RBC etc... into reset */
        WREG32(mmUVD_SOFT_RESET, UVD_SOFT_RESET__LMI_SOFT_RESET_MASK |
                UVD_SOFT_RESET__VCPU_SOFT_RESET_MASK | UVD_SOFT_RESET__LBSI_SOFT_RESET_MASK |
                UVD_SOFT_RESET__RBC_SOFT_RESET_MASK | UVD_SOFT_RESET__CSM_SOFT_RESET_MASK |
                UVD_SOFT_RESET__CXW_SOFT_RESET_MASK | UVD_SOFT_RESET__TAP_SOFT_RESET_MASK |
                UVD_SOFT_RESET__LMI_UMC_SOFT_RESET_MASK);
        mdelay(5);

        /* take UVD block out of reset */
        WREG32_P(mmSRBM_SOFT_RESET, 0, ~SRBM_SOFT_RESET__SOFT_RESET_UVD_MASK);
        mdelay(5);

        /* initialize UVD memory controller */
        WREG32(mmUVD_LMI_CTRL, 0x40 | (1 << 8) | (1 << 13) |
                             (1 << 21) | (1 << 9) | (1 << 20));

#ifdef __BIG_ENDIAN
        /* swap (8 in 32) RB and IB */
        lmi_swap_cntl = 0xa;
        mp_swap_cntl = 0;
#endif
        WREG32(mmUVD_LMI_SWAP_CNTL, lmi_swap_cntl);
        WREG32(mmUVD_MP_SWAP_CNTL, mp_swap_cntl);

        WREG32(mmUVD_MPC_SET_MUXA0, 0x40c2040);
        WREG32(mmUVD_MPC_SET_MUXA1, 0x0);
        WREG32(mmUVD_MPC_SET_MUXB0, 0x40c2040);
        WREG32(mmUVD_MPC_SET_MUXB1, 0x0);
        WREG32(mmUVD_MPC_SET_ALU, 0);
        WREG32(mmUVD_MPC_SET_MUX, 0x88);

        /* take all subblocks out of reset, except VCPU */
        WREG32(mmUVD_SOFT_RESET, UVD_SOFT_RESET__VCPU_SOFT_RESET_MASK);
        mdelay(5);

        /* enable VCPU clock */
        WREG32(mmUVD_VCPU_CNTL,  1 << 9);

        /* enable UMC */
        WREG32_P(mmUVD_LMI_CTRL2, 0, ~(1 << 8));

        /* boot up the VCPU */
        WREG32(mmUVD_SOFT_RESET, 0);
        mdelay(10);

        for (i = 0; i < 10; ++i) {
                uint32_t status;
                for (j = 0; j < 100; ++j) {
                        status = RREG32(mmUVD_STATUS);
                        if (status & 2)
                                break;
                        mdelay(10);
                }
                r = 0;
                if (status & 2)
                        break;

                DRM_ERROR("UVD not responding, trying to reset the VCPU!!!\n");
                WREG32_P(mmUVD_SOFT_RESET, UVD_SOFT_RESET__VCPU_SOFT_RESET_MASK,
                                ~UVD_SOFT_RESET__VCPU_SOFT_RESET_MASK);
                mdelay(10);
                WREG32_P(mmUVD_SOFT_RESET, 0, ~UVD_SOFT_RESET__VCPU_SOFT_RESET_MASK);
                mdelay(10);
                r = -1;
        }

        if (r) {
                DRM_ERROR("UVD not responding, giving up!!!\n");
                return r;
        }
        /* enable master interrupt */
        WREG32_P(mmUVD_MASTINT_EN, 3 << 1, ~(3 << 1));

        /* clear the bit 4 of UVD_STATUS */
        WREG32_P(mmUVD_STATUS, 0, ~(2 << 1));

        rb_bufsz = order_base_2(ring->ring_size);
        tmp = 0;
        tmp = REG_SET_FIELD(tmp, UVD_RBC_RB_CNTL, RB_BUFSZ, rb_bufsz);
        tmp = REG_SET_FIELD(tmp, UVD_RBC_RB_CNTL, RB_BLKSZ, 1);
        tmp = REG_SET_FIELD(tmp, UVD_RBC_RB_CNTL, RB_NO_FETCH, 1);
        tmp = REG_SET_FIELD(tmp, UVD_RBC_RB_CNTL, RB_WPTR_POLL_EN, 0);
        tmp = REG_SET_FIELD(tmp, UVD_RBC_RB_CNTL, RB_NO_UPDATE, 1);
        tmp = REG_SET_FIELD(tmp, UVD_RBC_RB_CNTL, RB_RPTR_WR_EN, 1);
        /* force RBC into idle state */
        WREG32(mmUVD_RBC_RB_CNTL, tmp);

        /* set the write pointer delay */
        WREG32(mmUVD_RBC_RB_WPTR_CNTL, 0);

        /* set the wb address */
        WREG32(mmUVD_RBC_RB_RPTR_ADDR, (upper_32_bits(ring->gpu_addr) >> 2));

        /* program the RB_BASE for ring buffer */
        WREG32(mmUVD_LMI_RBC_RB_64BIT_BAR_LOW,
                        lower_32_bits(ring->gpu_addr));
        WREG32(mmUVD_LMI_RBC_RB_64BIT_BAR_HIGH,
                        upper_32_bits(ring->gpu_addr));

        /* Initialize the ring buffer's read and write pointers */
        WREG32(mmUVD_RBC_RB_RPTR, 0);

        ring->wptr = RREG32(mmUVD_RBC_RB_RPTR);
        WREG32(mmUVD_RBC_RB_WPTR, lower_32_bits(ring->wptr));

        WREG32_P(mmUVD_RBC_RB_CNTL, 0, ~UVD_RBC_RB_CNTL__RB_NO_FETCH_MASK);

        return 0;
}

/**
 * uvd_v5_0_stop - stop UVD block
 *
 * @adev: amdgpu_device pointer
 *
 * stop the UVD block
 */
static void uvd_v5_0_stop(struct amdgpu_device *adev)
{
        /* force RBC into idle state */
        WREG32(mmUVD_RBC_RB_CNTL, 0x11010101);

        /* Stall UMC and register bus before resetting VCPU */
        WREG32_P(mmUVD_LMI_CTRL2, 1 << 8, ~(1 << 8));
        mdelay(1);

        /* put VCPU into reset */
        WREG32(mmUVD_SOFT_RESET, UVD_SOFT_RESET__VCPU_SOFT_RESET_MASK);
        mdelay(5);

        /* disable VCPU clock */
        WREG32(mmUVD_VCPU_CNTL, 0x0);

        /* Unstall UMC and register bus */
        WREG32_P(mmUVD_LMI_CTRL2, 0, ~(1 << 8));

        WREG32(mmUVD_STATUS, 0);
}

/**
 * uvd_v5_0_ring_emit_fence - emit an fence & trap command
 *
 * @ring: amdgpu_ring pointer
 * @addr: address
 * @seq: sequence number
 * @flags: fence related flags
 *
 * Write a fence and a trap command to the ring.
 */
static void uvd_v5_0_ring_emit_fence(struct amdgpu_ring *ring, u64 addr, u64 seq,
                                     unsigned flags)
{
        WARN_ON(flags & AMDGPU_FENCE_FLAG_64BIT);

        amdgpu_ring_write(ring, PACKET0(mmUVD_CONTEXT_ID, 0));
        amdgpu_ring_write(ring, seq);
        amdgpu_ring_write(ring, PACKET0(mmUVD_GPCOM_VCPU_DATA0, 0));
        amdgpu_ring_write(ring, addr & 0xffffffff);
        amdgpu_ring_write(ring, PACKET0(mmUVD_GPCOM_VCPU_DATA1, 0));
        amdgpu_ring_write(ring, upper_32_bits(addr) & 0xff);
        amdgpu_ring_write(ring, PACKET0(mmUVD_GPCOM_VCPU_CMD, 0));
        amdgpu_ring_write(ring, 0);

        amdgpu_ring_write(ring, PACKET0(mmUVD_GPCOM_VCPU_DATA0, 0));
        amdgpu_ring_write(ring, 0);
        amdgpu_ring_write(ring, PACKET0(mmUVD_GPCOM_VCPU_DATA1, 0));
        amdgpu_ring_write(ring, 0);
        amdgpu_ring_write(ring, PACKET0(mmUVD_GPCOM_VCPU_CMD, 0));
        amdgpu_ring_write(ring, 2);
}

/**
 * uvd_v5_0_ring_test_ring - register write test
 *
 * @ring: amdgpu_ring pointer
 *
 * Test if we can successfully write to the context register
 */
static int uvd_v5_0_ring_test_ring(struct amdgpu_ring *ring)
{
        struct amdgpu_device *adev = ring->adev;
        uint32_t tmp = 0;
        unsigned i;
        int r;

        WREG32(mmUVD_CONTEXT_ID, 0xCAFEDEAD);
        r = amdgpu_ring_alloc(ring, 3);
        if (r)
                return r;
        amdgpu_ring_write(ring, PACKET0(mmUVD_CONTEXT_ID, 0));
        amdgpu_ring_write(ring, 0xDEADBEEF);
        amdgpu_ring_commit(ring);
        for (i = 0; i < adev->usec_timeout; i++) {
                tmp = RREG32(mmUVD_CONTEXT_ID);
                if (tmp == 0xDEADBEEF)
                        break;
                udelay(1);
        }

        if (i >= adev->usec_timeout)
                r = -ETIMEDOUT;

        return r;
}

/**
 * uvd_v5_0_ring_emit_ib - execute indirect buffer
 *
 * @ring: amdgpu_ring pointer
 * @job: job to retrieve vmid from
 * @ib: indirect buffer to execute
 * @flags: unused
 *
 * Write ring commands to execute the indirect buffer
 */
static void uvd_v5_0_ring_emit_ib(struct amdgpu_ring *ring,
                                  struct amdgpu_job *job,
                                  struct amdgpu_ib *ib,
                                  uint32_t flags)
{
        amdgpu_ring_write(ring, PACKET0(mmUVD_LMI_RBC_IB_64BIT_BAR_LOW, 0));
        amdgpu_ring_write(ring, lower_32_bits(ib->gpu_addr));
        amdgpu_ring_write(ring, PACKET0(mmUVD_LMI_RBC_IB_64BIT_BAR_HIGH, 0));
        amdgpu_ring_write(ring, upper_32_bits(ib->gpu_addr));
        amdgpu_ring_write(ring, PACKET0(mmUVD_RBC_IB_SIZE, 0));
        amdgpu_ring_write(ring, ib->length_dw);
}

static void uvd_v5_0_ring_insert_nop(struct amdgpu_ring *ring, uint32_t count)
{
        int i;

        WARN_ON(ring->wptr % 2 || count % 2);

        for (i = 0; i < count / 2; i++) {
                amdgpu_ring_write(ring, PACKET0(mmUVD_NO_OP, 0));
                amdgpu_ring_write(ring, 0);
        }
}

static bool uvd_v5_0_is_idle(struct amdgpu_ip_block *ip_block)
{
        struct amdgpu_device *adev = ip_block->adev;

        return !(RREG32(mmSRBM_STATUS) & SRBM_STATUS__UVD_BUSY_MASK);
}

static int uvd_v5_0_wait_for_idle(struct amdgpu_ip_block *ip_block)
{
        unsigned i;
        struct amdgpu_device *adev = ip_block->adev;

        for (i = 0; i < adev->usec_timeout; i++) {
                if (!(RREG32(mmSRBM_STATUS) & SRBM_STATUS__UVD_BUSY_MASK))
                        return 0;
        }
        return -ETIMEDOUT;
}

static int uvd_v5_0_soft_reset(struct amdgpu_ip_block *ip_block)
{
        struct amdgpu_device *adev = ip_block->adev;

        uvd_v5_0_stop(adev);

        WREG32_P(mmSRBM_SOFT_RESET, SRBM_SOFT_RESET__SOFT_RESET_UVD_MASK,
                        ~SRBM_SOFT_RESET__SOFT_RESET_UVD_MASK);
        mdelay(5);

        return uvd_v5_0_start(adev);
}

static int uvd_v5_0_set_interrupt_state(struct amdgpu_device *adev,
                                        struct amdgpu_irq_src *source,
                                        unsigned type,
                                        enum amdgpu_interrupt_state state)
{
        // TODO
        return 0;
}

static int uvd_v5_0_process_interrupt(struct amdgpu_device *adev,
                                      struct amdgpu_irq_src *source,
                                      struct amdgpu_iv_entry *entry)
{
        DRM_DEBUG("IH: UVD TRAP\n");
        amdgpu_fence_process(&adev->uvd.inst->ring);
        return 0;
}

static void uvd_v5_0_enable_clock_gating(struct amdgpu_device *adev, bool enable)
{
        uint32_t data1, data3, suvd_flags;

        data1 = RREG32(mmUVD_SUVD_CGC_GATE);
        data3 = RREG32(mmUVD_CGC_GATE);

        suvd_flags = UVD_SUVD_CGC_GATE__SRE_MASK |
                     UVD_SUVD_CGC_GATE__SIT_MASK |
                     UVD_SUVD_CGC_GATE__SMP_MASK |
                     UVD_SUVD_CGC_GATE__SCM_MASK |
                     UVD_SUVD_CGC_GATE__SDB_MASK;

        if (enable) {
                data3 |= (UVD_CGC_GATE__SYS_MASK     |
                        UVD_CGC_GATE__UDEC_MASK      |
                        UVD_CGC_GATE__MPEG2_MASK     |
                        UVD_CGC_GATE__RBC_MASK       |
                        UVD_CGC_GATE__LMI_MC_MASK    |
                        UVD_CGC_GATE__IDCT_MASK      |
                        UVD_CGC_GATE__MPRD_MASK      |
                        UVD_CGC_GATE__MPC_MASK       |
                        UVD_CGC_GATE__LBSI_MASK      |
                        UVD_CGC_GATE__LRBBM_MASK     |
                        UVD_CGC_GATE__UDEC_RE_MASK   |
                        UVD_CGC_GATE__UDEC_CM_MASK   |
                        UVD_CGC_GATE__UDEC_IT_MASK   |
                        UVD_CGC_GATE__UDEC_DB_MASK   |
                        UVD_CGC_GATE__UDEC_MP_MASK   |
                        UVD_CGC_GATE__WCB_MASK       |
                        UVD_CGC_GATE__JPEG_MASK      |
                        UVD_CGC_GATE__SCPU_MASK);
                /* only in pg enabled, we can gate clock to vcpu*/
                if (adev->pg_flags & AMD_PG_SUPPORT_UVD)
                        data3 |= UVD_CGC_GATE__VCPU_MASK;
                data3 &= ~UVD_CGC_GATE__REGS_MASK;
                data1 |= suvd_flags;
        } else {
                data3 = 0;
                data1 = 0;
        }

        WREG32(mmUVD_SUVD_CGC_GATE, data1);
        WREG32(mmUVD_CGC_GATE, data3);
}

static void uvd_v5_0_set_sw_clock_gating(struct amdgpu_device *adev)
{
        uint32_t data, data2;

        data = RREG32(mmUVD_CGC_CTRL);
        data2 = RREG32(mmUVD_SUVD_CGC_CTRL);


        data &= ~(UVD_CGC_CTRL__CLK_OFF_DELAY_MASK |
                  UVD_CGC_CTRL__CLK_GATE_DLY_TIMER_MASK);


        data |= UVD_CGC_CTRL__DYN_CLOCK_MODE_MASK |
                (1 << REG_FIELD_SHIFT(UVD_CGC_CTRL, CLK_GATE_DLY_TIMER)) |
                (4 << REG_FIELD_SHIFT(UVD_CGC_CTRL, CLK_OFF_DELAY));

        data &= ~(UVD_CGC_CTRL__UDEC_RE_MODE_MASK |
                        UVD_CGC_CTRL__UDEC_CM_MODE_MASK |
                        UVD_CGC_CTRL__UDEC_IT_MODE_MASK |
                        UVD_CGC_CTRL__UDEC_DB_MODE_MASK |
                        UVD_CGC_CTRL__UDEC_MP_MODE_MASK |
                        UVD_CGC_CTRL__SYS_MODE_MASK |
                        UVD_CGC_CTRL__UDEC_MODE_MASK |
                        UVD_CGC_CTRL__MPEG2_MODE_MASK |
                        UVD_CGC_CTRL__REGS_MODE_MASK |
                        UVD_CGC_CTRL__RBC_MODE_MASK |
                        UVD_CGC_CTRL__LMI_MC_MODE_MASK |
                        UVD_CGC_CTRL__LMI_UMC_MODE_MASK |
                        UVD_CGC_CTRL__IDCT_MODE_MASK |
                        UVD_CGC_CTRL__MPRD_MODE_MASK |
                        UVD_CGC_CTRL__MPC_MODE_MASK |
                        UVD_CGC_CTRL__LBSI_MODE_MASK |
                        UVD_CGC_CTRL__LRBBM_MODE_MASK |
                        UVD_CGC_CTRL__WCB_MODE_MASK |
                        UVD_CGC_CTRL__VCPU_MODE_MASK |
                        UVD_CGC_CTRL__JPEG_MODE_MASK |
                        UVD_CGC_CTRL__SCPU_MODE_MASK);
        data2 &= ~(UVD_SUVD_CGC_CTRL__SRE_MODE_MASK |
                        UVD_SUVD_CGC_CTRL__SIT_MODE_MASK |
                        UVD_SUVD_CGC_CTRL__SMP_MODE_MASK |
                        UVD_SUVD_CGC_CTRL__SCM_MODE_MASK |
                        UVD_SUVD_CGC_CTRL__SDB_MODE_MASK);

        WREG32(mmUVD_CGC_CTRL, data);
        WREG32(mmUVD_SUVD_CGC_CTRL, data2);
}

#if 0
static void uvd_v5_0_set_hw_clock_gating(struct amdgpu_device *adev)
{
        uint32_t data, data1, cgc_flags, suvd_flags;

        data = RREG32(mmUVD_CGC_GATE);
        data1 = RREG32(mmUVD_SUVD_CGC_GATE);

        cgc_flags = UVD_CGC_GATE__SYS_MASK |
                                UVD_CGC_GATE__UDEC_MASK |
                                UVD_CGC_GATE__MPEG2_MASK |
                                UVD_CGC_GATE__RBC_MASK |
                                UVD_CGC_GATE__LMI_MC_MASK |
                                UVD_CGC_GATE__IDCT_MASK |
                                UVD_CGC_GATE__MPRD_MASK |
                                UVD_CGC_GATE__MPC_MASK |
                                UVD_CGC_GATE__LBSI_MASK |
                                UVD_CGC_GATE__LRBBM_MASK |
                                UVD_CGC_GATE__UDEC_RE_MASK |
                                UVD_CGC_GATE__UDEC_CM_MASK |
                                UVD_CGC_GATE__UDEC_IT_MASK |
                                UVD_CGC_GATE__UDEC_DB_MASK |
                                UVD_CGC_GATE__UDEC_MP_MASK |
                                UVD_CGC_GATE__WCB_MASK |
                                UVD_CGC_GATE__VCPU_MASK |
                                UVD_CGC_GATE__SCPU_MASK;

        suvd_flags = UVD_SUVD_CGC_GATE__SRE_MASK |
                                UVD_SUVD_CGC_GATE__SIT_MASK |
                                UVD_SUVD_CGC_GATE__SMP_MASK |
                                UVD_SUVD_CGC_GATE__SCM_MASK |
                                UVD_SUVD_CGC_GATE__SDB_MASK;

        data |= cgc_flags;
        data1 |= suvd_flags;

        WREG32(mmUVD_CGC_GATE, data);
        WREG32(mmUVD_SUVD_CGC_GATE, data1);
}
#endif

static void uvd_v5_0_enable_mgcg(struct amdgpu_device *adev,
                                 bool enable)
{
        u32 orig, data;

        if (enable && (adev->cg_flags & AMD_CG_SUPPORT_UVD_MGCG)) {
                data = RREG32_UVD_CTX(ixUVD_CGC_MEM_CTRL);
                data |= 0xfff;
                WREG32_UVD_CTX(ixUVD_CGC_MEM_CTRL, data);

                orig = data = RREG32(mmUVD_CGC_CTRL);
                data |= UVD_CGC_CTRL__DYN_CLOCK_MODE_MASK;
                if (orig != data)
                        WREG32(mmUVD_CGC_CTRL, data);
        } else {
                data = RREG32_UVD_CTX(ixUVD_CGC_MEM_CTRL);
                data &= ~0xfff;
                WREG32_UVD_CTX(ixUVD_CGC_MEM_CTRL, data);

                orig = data = RREG32(mmUVD_CGC_CTRL);
                data &= ~UVD_CGC_CTRL__DYN_CLOCK_MODE_MASK;
                if (orig != data)
                        WREG32(mmUVD_CGC_CTRL, data);
        }
}

static int uvd_v5_0_set_clockgating_state(struct amdgpu_ip_block *ip_block,
                                          enum amd_clockgating_state state)
{
        struct amdgpu_device *adev = ip_block->adev;
        bool enable = (state == AMD_CG_STATE_GATE);

        if (enable) {
                /* wait for STATUS to clear */
                if (uvd_v5_0_wait_for_idle(ip_block))
                        return -EBUSY;
                uvd_v5_0_enable_clock_gating(adev, true);

                /* enable HW gates because UVD is idle */
/*              uvd_v5_0_set_hw_clock_gating(adev); */
        } else {
                uvd_v5_0_enable_clock_gating(adev, false);
        }

        uvd_v5_0_set_sw_clock_gating(adev);
        return 0;
}

static int uvd_v5_0_set_powergating_state(struct amdgpu_ip_block *ip_block,
                                          enum amd_powergating_state state)
{
        /* This doesn't actually powergate the UVD block.
         * That's done in the dpm code via the SMC.  This
         * just re-inits the block as necessary.  The actual
         * gating still happens in the dpm code.  We should
         * revisit this when there is a cleaner line between
         * the smc and the hw blocks
         */
        struct amdgpu_device *adev = ip_block->adev;
        int ret = 0;

        if (state == AMD_PG_STATE_GATE) {
                uvd_v5_0_stop(adev);
        } else {
                ret = uvd_v5_0_start(adev);
                if (ret)
                        goto out;
        }

out:
        return ret;
}

static void uvd_v5_0_get_clockgating_state(struct amdgpu_ip_block *ip_block, u64 *flags)
{
        struct amdgpu_device *adev = ip_block->adev;
        int data;

        mutex_lock(&adev->pm.mutex);

        if (RREG32_SMC(ixCURRENT_PG_STATUS) &
                                CURRENT_PG_STATUS__UVD_PG_STATUS_MASK) {
                DRM_INFO("Cannot get clockgating state when UVD is powergated.\n");
                goto out;
        }

        /* AMD_CG_SUPPORT_UVD_MGCG */
        data = RREG32(mmUVD_CGC_CTRL);
        if (data & UVD_CGC_CTRL__DYN_CLOCK_MODE_MASK)
                *flags |= AMD_CG_SUPPORT_UVD_MGCG;

out:
        mutex_unlock(&adev->pm.mutex);
}

static const struct amd_ip_funcs uvd_v5_0_ip_funcs = {
        .name = "uvd_v5_0",
        .early_init = uvd_v5_0_early_init,
        .sw_init = uvd_v5_0_sw_init,
        .sw_fini = uvd_v5_0_sw_fini,
        .hw_init = uvd_v5_0_hw_init,
        .hw_fini = uvd_v5_0_hw_fini,
        .prepare_suspend = uvd_v5_0_prepare_suspend,
        .suspend = uvd_v5_0_suspend,
        .resume = uvd_v5_0_resume,
        .is_idle = uvd_v5_0_is_idle,
        .wait_for_idle = uvd_v5_0_wait_for_idle,
        .soft_reset = uvd_v5_0_soft_reset,
        .set_clockgating_state = uvd_v5_0_set_clockgating_state,
        .set_powergating_state = uvd_v5_0_set_powergating_state,
        .get_clockgating_state = uvd_v5_0_get_clockgating_state,
};

static const struct amdgpu_ring_funcs uvd_v5_0_ring_funcs = {
        .type = AMDGPU_RING_TYPE_UVD,
        .align_mask = 0xf,
        .support_64bit_ptrs = false,
        .no_user_fence = true,
        .get_rptr = uvd_v5_0_ring_get_rptr,
        .get_wptr = uvd_v5_0_ring_get_wptr,
        .set_wptr = uvd_v5_0_ring_set_wptr,
        .parse_cs = amdgpu_uvd_ring_parse_cs,
        .emit_frame_size =
                14, /* uvd_v5_0_ring_emit_fence  x1 no user fence */
        .emit_ib_size = 6, /* uvd_v5_0_ring_emit_ib */
        .emit_ib = uvd_v5_0_ring_emit_ib,
        .emit_fence = uvd_v5_0_ring_emit_fence,
        .test_ring = uvd_v5_0_ring_test_ring,
        .test_ib = amdgpu_uvd_ring_test_ib,
        .insert_nop = uvd_v5_0_ring_insert_nop,
        .pad_ib = amdgpu_ring_generic_pad_ib,
        .begin_use = amdgpu_uvd_ring_begin_use,
        .end_use = amdgpu_uvd_ring_end_use,
};

static void uvd_v5_0_set_ring_funcs(struct amdgpu_device *adev)
{
        adev->uvd.inst->ring.funcs = &uvd_v5_0_ring_funcs;
}

static const struct amdgpu_irq_src_funcs uvd_v5_0_irq_funcs = {
        .set = uvd_v5_0_set_interrupt_state,
        .process = uvd_v5_0_process_interrupt,
};

static void uvd_v5_0_set_irq_funcs(struct amdgpu_device *adev)
{
        adev->uvd.inst->irq.num_types = 1;
        adev->uvd.inst->irq.funcs = &uvd_v5_0_irq_funcs;
}

const struct amdgpu_ip_block_version uvd_v5_0_ip_block =
{
                .type = AMD_IP_BLOCK_TYPE_UVD,
                .major = 5,
                .minor = 0,
                .rev = 0,
                .funcs = &uvd_v5_0_ip_funcs,
};