hal_uart.h

/* Copyright Statement:
 *
 * (C) 2005-2017  MediaTek Inc. All rights reserved.
 *
 * This 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") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by 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,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __HAL_UART_H__
#define __HAL_UART_H__

#include "hal_platform.h"

#ifdef HAL_UART_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
    HAL_UART_BAUDRATE_110 = 0,           
    HAL_UART_BAUDRATE_300 = 1,           
    HAL_UART_BAUDRATE_1200 = 2,          
    HAL_UART_BAUDRATE_2400 = 3,          
    HAL_UART_BAUDRATE_4800 = 4,          
    HAL_UART_BAUDRATE_9600 = 5,          
    HAL_UART_BAUDRATE_19200 = 6,         
    HAL_UART_BAUDRATE_38400 = 7,         
    HAL_UART_BAUDRATE_57600 = 8,         
    HAL_UART_BAUDRATE_115200 = 9,        
    HAL_UART_BAUDRATE_230400 = 10,       
    HAL_UART_BAUDRATE_460800 = 11,       
    HAL_UART_BAUDRATE_921600 = 12,       
    HAL_UART_BAUDRATE_MAX                
} hal_uart_baudrate_t;


typedef enum {
    HAL_UART_WORD_LENGTH_5 = 0,           
    HAL_UART_WORD_LENGTH_6 = 1,           
    HAL_UART_WORD_LENGTH_7 = 2,           
    HAL_UART_WORD_LENGTH_8 = 3            
} hal_uart_word_length_t;


typedef enum {
    HAL_UART_STOP_BIT_1 = 0,              
    HAL_UART_STOP_BIT_2 = 1,              
} hal_uart_stop_bit_t;


typedef enum {
    HAL_UART_PARITY_NONE = 0,            
    HAL_UART_PARITY_ODD = 1,             
    HAL_UART_PARITY_EVEN = 2             
} hal_uart_parity_t;


typedef enum {
    HAL_UART_STATUS_ERROR_PARAMETER = -4,      
    HAL_UART_STATUS_ERROR_BUSY = -3,           
    HAL_UART_STATUS_ERROR_UNINITIALIZED = -2,  
    HAL_UART_STATUS_ERROR = -1,                
    HAL_UART_STATUS_OK = 0                     
} hal_uart_status_t;


typedef enum {
    HAL_UART_EVENT_TRANSACTION_ERROR = -1,          
    HAL_UART_EVENT_READY_TO_READ = 1,               
    HAL_UART_EVENT_READY_TO_WRITE = 2               
} hal_uart_callback_event_t;


typedef struct {
    hal_uart_baudrate_t baudrate;              
    hal_uart_word_length_t word_length;        
    hal_uart_stop_bit_t stop_bit;              
    hal_uart_parity_t parity;                  
} hal_uart_config_t;


typedef struct {
    uint8_t *send_vfifo_buffer;                
    uint32_t send_vfifo_buffer_size;           
    uint32_t send_vfifo_threshold_size;        
    uint8_t *receive_vfifo_buffer;             
    uint32_t receive_vfifo_buffer_size;        
    uint32_t receive_vfifo_threshold_size;     
    uint32_t receive_vfifo_alert_size;         
} hal_uart_dma_config_t;


typedef void (*hal_uart_callback_t)(hal_uart_callback_event_t event, void *user_data);


hal_uart_status_t hal_uart_init(hal_uart_port_t uart_port, hal_uart_config_t *uart_config);


hal_uart_status_t hal_uart_deinit(hal_uart_port_t uart_port);


void hal_uart_put_char(hal_uart_port_t uart_port, char byte);


char hal_uart_get_char(hal_uart_port_t uart_port);


uint32_t hal_uart_get_char_unblocking(hal_uart_port_t uart_port);


uint32_t hal_uart_send_polling(hal_uart_port_t uart_port, const uint8_t *data, uint32_t size);


uint32_t hal_uart_send_dma(hal_uart_port_t uart_port, const uint8_t *data, uint32_t size);


uint32_t hal_uart_receive_polling(hal_uart_port_t uart_port, uint8_t *buffer, uint32_t size);


uint32_t hal_uart_receive_dma(hal_uart_port_t uart_port, uint8_t *buffer, uint32_t size);


uint32_t hal_uart_get_available_send_space(hal_uart_port_t uart_port);


uint32_t hal_uart_get_available_receive_bytes(hal_uart_port_t uart_port);


hal_uart_status_t hal_uart_register_callback(hal_uart_port_t uart_port,
        hal_uart_callback_t user_callback,
        void *user_data);


hal_uart_status_t hal_uart_set_hardware_flowcontrol(hal_uart_port_t uart_port);


hal_uart_status_t hal_uart_set_software_flowcontrol(hal_uart_port_t uart_port,
        uint8_t xon,
        uint8_t xoff,
        uint8_t escape_character);


hal_uart_status_t hal_uart_disable_flowcontrol(hal_uart_port_t uart_port);


hal_uart_status_t hal_uart_set_baudrate(hal_uart_port_t uart_port, hal_uart_baudrate_t baudrate);


hal_uart_status_t hal_uart_set_format(hal_uart_port_t uart_port, const hal_uart_config_t *config);


hal_uart_status_t hal_uart_set_dma(hal_uart_port_t uart_port, const hal_uart_dma_config_t *dma_config);


#ifdef HAL_UART_FEATURE_VFIFO_DMA_TIMEOUT

hal_uart_status_t hal_uart_set_dma_timeout(hal_uart_port_t uart_port, uint32_t timeout);
#endif


#ifdef __cplusplus
}
#endif


#endif /* HAL_UART_MODULE_ENABLED */
#endif /* __HAL_UART_H__ */