/*
 * Copyright 2012-15 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: AMD
 *
 */

#include "dm_services.h"

/*
 * Pre-requisites: headers required by header of this unit
 */
#include "include/i2caux_interface.h"
#include "../i2caux.h"
#include "../engine.h"
#include "../i2c_engine.h"
#include "../i2c_sw_engine.h"
#include "../i2c_hw_engine.h"

/*
 * Header of this unit
 */
#include "i2caux_dce110.h"

#include "i2c_sw_engine_dce110.h"
#include "i2c_hw_engine_dce110.h"
#include "aux_engine_dce110.h"
#include "../../dc.h"
#include "dc_types.h"


/*
 * Post-requisites: headers required by this unit
 */

/*
 * This unit
 */
/*cast pointer to struct i2caux TO pointer to struct i2caux_dce110*/
#define FROM_I2C_AUX(ptr) \
        container_of((ptr), struct i2caux_dce110, base)

static void destruct(
        struct i2caux_dce110 *i2caux_dce110)
{
        dal_i2caux_destruct(&i2caux_dce110->base);
}

static void destroy(
        struct i2caux **i2c_engine)
{
        struct i2caux_dce110 *i2caux_dce110 = FROM_I2C_AUX(*i2c_engine);

        destruct(i2caux_dce110);

        kfree(i2caux_dce110);

        *i2c_engine = NULL;
}

static struct i2c_engine *acquire_i2c_hw_engine(
        struct i2caux *i2caux,
        struct ddc *ddc)
{
        struct i2caux_dce110 *i2caux_dce110 = FROM_I2C_AUX(i2caux);

        struct i2c_engine *engine = NULL;
        /* generic hw engine is not used for EDID read
         * It may be needed for external i2c device, like thermal chip,
         * TODO will be implemented when needed.
         * check dce80 bool non_generic for generic hw engine;
         */

        if (!ddc)
                return NULL;

        if (ddc->hw_info.hw_supported) {
                enum gpio_ddc_line line = dal_ddc_get_line(ddc);

                if (line < GPIO_DDC_LINE_COUNT)
                        engine = i2caux->i2c_hw_engines[line];
        }

        if (!engine)
                return NULL;

        if (!i2caux_dce110->i2c_hw_buffer_in_use &&
                engine->base.funcs->acquire(&engine->base, ddc)) {
                i2caux_dce110->i2c_hw_buffer_in_use = true;
                return engine;
        }

        return NULL;
}

static void release_engine(
        struct i2caux *i2caux,
        struct engine *engine)
{
        struct i2caux_dce110 *i2caux_dce110 = FROM_I2C_AUX(i2caux);

        if (engine->funcs->get_engine_type(engine) ==
                I2CAUX_ENGINE_TYPE_I2C_DDC_HW)
                i2caux_dce110->i2c_hw_buffer_in_use = false;

        dal_i2caux_release_engine(i2caux, engine);
}

static const enum gpio_ddc_line hw_ddc_lines[] = {
        GPIO_DDC_LINE_DDC1,
        GPIO_DDC_LINE_DDC2,
        GPIO_DDC_LINE_DDC3,
        GPIO_DDC_LINE_DDC4,
        GPIO_DDC_LINE_DDC5,
        GPIO_DDC_LINE_DDC6,
};

static const enum gpio_ddc_line hw_aux_lines[] = {
        GPIO_DDC_LINE_DDC1,
        GPIO_DDC_LINE_DDC2,
        GPIO_DDC_LINE_DDC3,
        GPIO_DDC_LINE_DDC4,
        GPIO_DDC_LINE_DDC5,
        GPIO_DDC_LINE_DDC6,
};

/* function table */
static const struct i2caux_funcs i2caux_funcs = {
        .destroy = destroy,
        .acquire_i2c_hw_engine = acquire_i2c_hw_engine,
        .release_engine = release_engine,
        .acquire_i2c_sw_engine = dal_i2caux_acquire_i2c_sw_engine,
        .acquire_aux_engine = dal_i2caux_acquire_aux_engine,
};

#include "dce/dce_11_0_d.h"
#include "dce/dce_11_0_sh_mask.h"

/* set register offset */
#define SR(reg_name)\
        .reg_name = mm ## reg_name

/* set register offset with instance */
#define SRI(reg_name, block, id)\
        .reg_name = mm ## block ## id ## _ ## reg_name

#define aux_regs(id)\
[id] = {\
        AUX_COMMON_REG_LIST(id), \
        .AUX_RESET_MASK = AUX_CONTROL__AUX_RESET_MASK \
}

#define hw_engine_regs(id)\
{\
                I2C_HW_ENGINE_COMMON_REG_LIST(id) \
}

static const struct dce110_aux_registers dce110_aux_regs[] = {
                aux_regs(0),
                aux_regs(1),
                aux_regs(2),
                aux_regs(3),
                aux_regs(4),
                aux_regs(5)
};

static const struct dce110_i2c_hw_engine_registers i2c_hw_engine_regs[] = {
                hw_engine_regs(1),
                hw_engine_regs(2),
                hw_engine_regs(3),
                hw_engine_regs(4),
                hw_engine_regs(5),
                hw_engine_regs(6)
};

static const struct dce110_i2c_hw_engine_shift i2c_shift = {
                I2C_COMMON_MASK_SH_LIST_DCE110(__SHIFT)
};

static const struct dce110_i2c_hw_engine_mask i2c_mask = {
                I2C_COMMON_MASK_SH_LIST_DCE110(_MASK)
};

void dal_i2caux_dce110_construct(
        struct i2caux_dce110 *i2caux_dce110,
        struct dc_context *ctx,
        unsigned int num_i2caux_inst,
        const struct dce110_aux_registers aux_regs[],
        const struct dce110_i2c_hw_engine_registers i2c_hw_engine_regs[],
        const struct dce110_i2c_hw_engine_shift *i2c_shift,
        const struct dce110_i2c_hw_engine_mask *i2c_mask)
{
        uint32_t i = 0;
        uint32_t reference_frequency = 0;
        bool use_i2c_sw_engine = false;
        struct i2caux *base = NULL;
        /*TODO: For CZ bring up, if dal_i2caux_get_reference_clock
         * does not return 48KHz, we need hard coded for 48Khz.
         * Some BIOS setting incorrect cause this
         * For production, we always get value from BIOS*/
        reference_frequency =
                dal_i2caux_get_reference_clock(ctx->dc_bios) >> 1;

        base = &i2caux_dce110->base;

        dal_i2caux_construct(base, ctx);

        i2caux_dce110->base.funcs = &i2caux_funcs;
        i2caux_dce110->i2c_hw_buffer_in_use = false;
        /* Create I2C engines (DDC lines per connector)
         * different I2C/AUX usage cases, DDC, Generic GPIO, AUX.
         */
        do {
                enum gpio_ddc_line line_id = hw_ddc_lines[i];

                struct i2c_hw_engine_dce110_create_arg hw_arg_dce110;

                if (use_i2c_sw_engine) {
                        struct i2c_sw_engine_dce110_create_arg sw_arg;

                        sw_arg.engine_id = i;
                        sw_arg.default_speed = base->default_i2c_sw_speed;
                        sw_arg.ctx = ctx;
                        base->i2c_sw_engines[line_id] =
                                dal_i2c_sw_engine_dce110_create(&sw_arg);
                }

                hw_arg_dce110.engine_id = i;
                hw_arg_dce110.reference_frequency = reference_frequency;
                hw_arg_dce110.default_speed = base->default_i2c_hw_speed;
                hw_arg_dce110.ctx = ctx;
                hw_arg_dce110.regs = &i2c_hw_engine_regs[i];
                hw_arg_dce110.i2c_shift = i2c_shift;
                hw_arg_dce110.i2c_mask = i2c_mask;

                base->i2c_hw_engines[line_id] =
                        dal_i2c_hw_engine_dce110_create(&hw_arg_dce110);
                if (base->i2c_hw_engines[line_id] != NULL) {
                        switch (ctx->dce_version) {
                        case DCN_VERSION_1_0:
                                base->i2c_hw_engines[line_id]->setup_limit =
                                        I2C_SETUP_TIME_LIMIT_DCN;
                                base->i2c_hw_engines[line_id]->send_reset_length  = 0;
                        break;
                        default:
                                base->i2c_hw_engines[line_id]->setup_limit =
                                        I2C_SETUP_TIME_LIMIT_DCE;
                                base->i2c_hw_engines[line_id]->send_reset_length  = 0;
                                break;
                        }
                }
                ++i;
        } while (i < num_i2caux_inst);

        /* Create AUX engines for all lines which has assisted HW AUX
         * 'i' (loop counter) used as DDC/AUX engine_id */

        i = 0;

        do {
                enum gpio_ddc_line line_id = hw_aux_lines[i];

                struct aux_engine_dce110_init_data aux_init_data;

                aux_init_data.engine_id = i;
                aux_init_data.timeout_period = base->aux_timeout_period;
                aux_init_data.ctx = ctx;
                aux_init_data.regs = &aux_regs[i];

                base->aux_engines[line_id] =
                        dal_aux_engine_dce110_create(&aux_init_data);

                ++i;
        } while (i < num_i2caux_inst);

        /*TODO Generic I2C SW and HW*/
}

/*
 * dal_i2caux_dce110_create
 *
 * @brief
 * public interface to allocate memory for DCE11 I2CAUX
 *
 * @param
 * struct adapter_service *as - [in]
 * struct dc_context *ctx - [in]
 *
 * @return
 * pointer to the base struct of DCE11 I2CAUX
 */
struct i2caux *dal_i2caux_dce110_create(
        struct dc_context *ctx)
{
        struct i2caux_dce110 *i2caux_dce110 =
                kzalloc(sizeof(struct i2caux_dce110), GFP_KERNEL);

        if (!i2caux_dce110) {
                ASSERT_CRITICAL(false);
                return NULL;
        }

        dal_i2caux_dce110_construct(i2caux_dce110,
                                    ctx,
                                    ARRAY_SIZE(dce110_aux_regs),
                                    dce110_aux_regs,
                                    i2c_hw_engine_regs,
                                    &i2c_shift,
                                    &i2c_mask);
        return &i2caux_dce110->base;
}