/*
 * Copyright 2016 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.
 *
 */

#ifndef __AMDGPU_VCN_H__
#define __AMDGPU_VCN_H__

#define AMDGPU_VCN_STACK_SIZE           (128*1024)
#define AMDGPU_VCN_CONTEXT_SIZE (512*1024)

#define AMDGPU_VCN_FIRMWARE_OFFSET      256
#define AMDGPU_VCN_MAX_ENC_RINGS        3

#define VCN_DEC_CMD_FENCE               0x00000000
#define VCN_DEC_CMD_TRAP                0x00000001
#define VCN_DEC_CMD_WRITE_REG           0x00000004
#define VCN_DEC_CMD_REG_READ_COND_WAIT  0x00000006
#define VCN_DEC_CMD_PACKET_START        0x0000000a
#define VCN_DEC_CMD_PACKET_END          0x0000000b

#define VCN_ENC_CMD_NO_OP               0x00000000
#define VCN_ENC_CMD_END                 0x00000001
#define VCN_ENC_CMD_IB                  0x00000002
#define VCN_ENC_CMD_FENCE               0x00000003
#define VCN_ENC_CMD_TRAP                0x00000004
#define VCN_ENC_CMD_REG_WRITE           0x0000000b
#define VCN_ENC_CMD_REG_WAIT            0x0000000c

enum engine_status_constants {
        UVD_PGFSM_STATUS__UVDM_UVDU_PWR_ON = 0x2AAAA0,
        UVD_PGFSM_CONFIG__UVDM_UVDU_PWR_ON = 0x00000002,
        UVD_STATUS__UVD_BUSY = 0x00000004,
        GB_ADDR_CONFIG_DEFAULT = 0x26010011,
        UVD_STATUS__IDLE = 0x2,
        UVD_STATUS__BUSY = 0x5,
        UVD_POWER_STATUS__UVD_POWER_STATUS_TILES_OFF = 0x1,
        UVD_STATUS__RBC_BUSY = 0x1,
};

enum internal_dpg_state {
        VCN_DPG_STATE__UNPAUSE = 0,
        VCN_DPG_STATE__PAUSE,
};

struct dpg_pause_state {
        enum internal_dpg_state fw_based;
        enum internal_dpg_state jpeg;
};

struct amdgpu_vcn {
        struct amdgpu_bo        *vcpu_bo;
        void                    *cpu_addr;
        uint64_t                gpu_addr;
        unsigned                fw_version;
        void                    *saved_bo;
        struct delayed_work     idle_work;
        const struct firmware   *fw;    /* VCN firmware */
        struct amdgpu_ring      ring_dec;
        struct amdgpu_ring      ring_enc[AMDGPU_VCN_MAX_ENC_RINGS];
        struct amdgpu_ring      ring_jpeg;
        struct amdgpu_irq_src   irq;
        unsigned                num_enc_rings;
        enum amd_powergating_state cur_state;
        struct dpg_pause_state pause_state;
};

int amdgpu_vcn_sw_init(struct amdgpu_device *adev);
int amdgpu_vcn_sw_fini(struct amdgpu_device *adev);
int amdgpu_vcn_suspend(struct amdgpu_device *adev);
int amdgpu_vcn_resume(struct amdgpu_device *adev);
void amdgpu_vcn_ring_begin_use(struct amdgpu_ring *ring);
void amdgpu_vcn_ring_end_use(struct amdgpu_ring *ring);

int amdgpu_vcn_dec_ring_test_ring(struct amdgpu_ring *ring);
int amdgpu_vcn_dec_ring_test_ib(struct amdgpu_ring *ring, long timeout);

int amdgpu_vcn_enc_ring_test_ring(struct amdgpu_ring *ring);
int amdgpu_vcn_enc_ring_test_ib(struct amdgpu_ring *ring, long timeout);

int amdgpu_vcn_jpeg_ring_test_ring(struct amdgpu_ring *ring);
int amdgpu_vcn_jpeg_ring_test_ib(struct amdgpu_ring *ring, long timeout);

#endif