mhal_uart.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_UART_H__
#define __MHAL_UART_H__

#include "mhal_osai.h"

typedef enum {
    UART_DATA_5_BITS = 0x00,
    UART_DATA_6_BITS = 0x01,
    UART_DATA_7_BITS = 0x02,
    UART_DATA_8_BITS = 0x03,
} mhal_uart_data_len;

typedef enum {
    UART_NONE_PARITY = 0x00,
    UART_ODD_PARITY = 0x08,
    UART_EVEN_PARITY = 0x18,
    UART_MARK_PARITY = 0x28,
    UART_SPACE_PARITY = 0x38,
} mhal_uart_parity;

typedef enum {
    UART_STOP_1_BIT = 0x00,
    UART_STOP_2_BIT = 0x04,
} mhal_uart_stop_bit;
typedef int (*uart_dma_done_callback) (void *user_data);

struct mtk_uart_private {
    u8 dma_tx_ch;
    u8 dma_rx_ch;

    unsigned char *tx_buf;
    unsigned char *rx_buf;
    dma_addr_t tx_dma;
    dma_addr_t rx_dma;

    u32 tx_len;
    u32 rx_len;
    u32 tx_size;
    u32 rx_size;

    void *user_data;
    uart_dma_done_callback uart_tx_dma_callback;
    uart_dma_done_callback uart_rx_dma_callback;
};

struct mtk_uart_controller {
    u8 port_num;
    void __iomem *base;
    void __iomem *cg_base;
    u32 baudrate;
    mhal_uart_data_len data_bit;
    mhal_uart_parity parity;
    mhal_uart_stop_bit stop_bit;
    u8 vff_dma_mode;
    struct mtk_uart_private *mdata;
};
#define UART_EPTR           (1)

#define UART_ENXIO          (6)

#define UART_EINVAL         (22)

#define UART_ETIMEDOUT      (110)

#define UART_INT_DISABLE        0x00

#define UART_INT_RX_BUFFER_FULL     0x01

#define UART_INT_TX_BUFFER_EMPTY    0x02

#define UART_INT_LINE_STATUS        0x04

#define UART_INT_SW_FLOW_CONTROL    0x20

#define UART_INT_HW_FLOW_CONTROL_RTS    0x40

#define UART_INT_HW_FLOW_CONTROL_CTS    0x80

#define UART_EFR_HW_FC_DISABLE      0x00

#define UART_EFR_HW_FC_RTS      0x40

#define UART_EFR_HW_FC_CTS      0x80

#define UART_EFR_HW_FC_RTS_CTS  0xC0

#ifdef __cplusplus
extern "C" {
#endif

int mtk_mhal_uart_enable_clk(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_disable_clk(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_sw_reset(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_dumpreg(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_hw_init(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_set_baudrate(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_set_format(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_set_hw_fc(struct mtk_uart_controller *ctlr, u8 hw_fc);

int mtk_mhal_uart_disable_sw_fc(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_set_sw_fc(struct mtk_uart_controller *ctlr,
        u8 xon1, u8 xoff1, u8 xon2, u8 xoff2, u8 escape_data);

int mtk_mhal_uart_set_dma(struct mtk_uart_controller *ctlr, bool enable_dma);

int mtk_mhal_uart_clear_irq_status(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_set_irq(struct mtk_uart_controller *ctlr, u8 int_flag);

int mtk_mhal_uart_putc(struct mtk_uart_controller *ctlr, u8 data);

int mtk_mhal_uart_getc(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_getc_nowait(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_allocate_dma_tx_ch(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_allocate_dma_rx_ch(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_release_dma_tx_ch(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_release_dma_rx_ch(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_dma_tx_config(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_dma_rx_config(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_start_dma_tx(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_start_dma_rx(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_stop_dma_tx(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_stop_dma_rx(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_update_dma_tx_info(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_update_dma_rx_info(struct mtk_uart_controller *ctlr);

int mtk_mhal_uart_dma_tx_callback_register(
        struct mtk_uart_controller *ctlr,
        uart_dma_done_callback callback,
        void *user_data);

int mtk_mhal_uart_dma_rx_callback_register(
        struct mtk_uart_controller *ctlr,
        uart_dma_done_callback callback,
        void *user_data);

#ifdef __cplusplus
}
#endif

#endif /*_MHAL_UART_H_*/