mhal_i2c.h

/*
 * (C) 2005-2020 MediaTek Inc. All rights reserved.
 *
 * Copyright Statement:
 *
 * This MT3620 driver software/firmware and related documentation
 * ("MediaTek Software") are protected under relevant copyright laws.
 * The information contained herein is confidential and proprietary to
 * MediaTek Inc. ("MediaTek"). You may only use, reproduce, modify, or
 * distribute (as applicable) MediaTek Software if you have agreed to and been
 * bound by this Statement and the applicable license agreement with MediaTek
 * ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 *
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE
 * PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS
 * ANY AND ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NONINFRINGEMENT. NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH
 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
 * INCORPORATED IN, OR SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO
 * LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN MEDIATEK
 * SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE
 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S
 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED
 * HEREUNDER WILL BE ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY
 * RECEIVER TO MEDIATEK DURING THE PRECEDING TWELVE (12) MONTHS FOR SUCH
 * MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __MHAL_I2C__H__
#define __MHAL_I2C__H__

#include "mhal_osai.h"

#define I2C_OK              0

#define I2C_EPTR            1

#define I2C_EFIFO           2

#define I2C_ENXIO           6

#define I2C_EBUSY           16

#define I2C_EINVAL          22

#define I2C_ETIMEDOUT           110

#define I2C_TRANS_DONE      0

#define I2C_WAIT_DMA        1

enum i2c_speed_kHz {
    I2C_SCL_50kHz = 1,
    I2C_SCL_100kHz = 2,
    I2C_SCL_200kHz = 3,
    I2C_SCL_400kHz = 4,
    I2C_SCL_1000kHz = 5
};

enum i2c_trans_op {
    I2C_MASTER_WR = 1,
    I2C_MASTER_RD = 2,
    I2C_SLAVE_RX = 3,
    I2C_SLAVE_TX = 4
};

/*@brief I2C controller role definition
 * Before performing transfer, users should indicate the
 * controller as the master role or slave role.
*/
enum i2c_trans_mode {
    I2C_MASTER_MODE = 0,
    I2C_SLAVE_MODE = 1
};

typedef int (*i2c_dma_done_callback) (void *user_data);

struct i2c_msg {
    u8 addr;
    enum i2c_trans_op flags;
    u16 len;
    u8 *buf;
};

struct mtk_i2c_private {
    u8 *tx_buff;
    u8 *rx_buff;
    dma_addr_t tx_dma_addr;
    dma_addr_t rx_dma_addr;
    u32 tx_len;
    u32 rx_len;
    void *user_data;

    i2c_dma_done_callback dma_done_callback;
};

struct mtk_i2c_controller {
    void __iomem *base;

    void __iomem *cg_base;

    int dma_tx_chan;
    int dma_rx_chan;

    struct i2c_msg *msg;

    u8 msg_num;

    bool dma_en;

    u32 irq_stat;

    u32 timeout;

    enum i2c_speed_kHz i2c_speed;

    enum i2c_trans_mode i2c_mode;

    u8 op;

    u8 slave_addr;

    struct mtk_i2c_private *mdata;
};

#ifdef __cplusplus
extern "C" {
#endif

int mtk_mhal_i2c_init_hw(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_trigger_transfer(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_irq_handle(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_result_handle(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_enable_clk(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_disable_clk(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_dump_register(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_init_speed(struct mtk_i2c_controller *i2c,
                enum i2c_speed_kHz);

int mtk_mhal_i2c_init_slv_addr(struct mtk_i2c_controller *i2c, u8 slv_addr);

int mtk_mhal_i2c_dma_done_callback_register(
        struct mtk_i2c_controller *i2c,
        i2c_dma_done_callback callback,
        void *user_data);

int mtk_mhal_i2c_request_dma(struct mtk_i2c_controller *i2c);

int mtk_mhal_i2c_release_dma(struct mtk_i2c_controller *i2c);

#ifdef __cplusplus
}
#endif

#endif