hal_usb.h

/* Copyright Statement:
 *
 * (C) 2005-2016  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_USB_H__
#define __HAL_USB_H__

#include "hal_platform.h"

#ifdef HAL_USB_MODULE_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

#define HAL_USB_MAX_NUMBER_ENDPOINT     4

#define HAL_USB_MAX_NUMBER_ENDPOINT_TX      4

#define HAL_USB_MAX_NUMBER_ENDPOINT_RX      2

#define HAL_USB_MAX_NUMBER_DMA          4

#define HAL_USB_MAX_PACKET_SIZE_ENDPOINT_0          64

#define HAL_USB_MAX_PACKET_SIZE_ENDPOINT_BULK_HIGH_SPEED    512

#define HAL_USB_MAX_PACKET_SIZE_ENDPOINT_BULK_FULL_SPEED    64

#define HAL_USB_MAX_PACKET_SIZE_ENDPOINT_ISOCHRONOUS_HIGH_SPEED 1024

#define HAL_USB_MAX_PACKET_SIZE_ENDPOINT_ISOCHRONOUS_FULL_SPEED       512

#define HAL_USB_MAX_PACKET_SIZE_ENDPOINT_INTERRUPT_HIGH_SPEED    64

#define HAL_USB_MAX_PACKET_SIZE_ENDPOINT_INTERRUPT_FULL_SPEED   64

typedef void (*hal_usb_driver_interrupt_handler_t)(void);
typedef void (*hal_usb_dma_handler_t)(void);
typedef enum {
    HAL_USB_STATUS_INVALID_PARAMETER = -2,  
    HAL_USB_STATUS_ERROR             = -1,  
    HAL_USB_STATUS_OK                =  0   
} hal_usb_status_t;

typedef enum {
    HAL_USB_POWER_STATE_NORMAL = 0,   
    HAL_USB_POWER_STATE_SUSPEND       
} hal_usb_power_state_t;


typedef enum {
    HAL_USB_DMA0_TYPE = 0, 
    HAL_USB_DMA1_TYPE,     
} hal_usb_dma_type_t;

typedef enum {
    HAL_USB_EP_USE_NO_DMA = 0,  
    HAL_USB_EP_USE_ONLY_DMA,    
} hal_usb_dma_usage_t;

typedef enum {
    HAL_USB_TEST_MODE_TYPE_NONE = 0,  
    HAL_USB_TEST_MODE_TYPE_J,         
    HAL_USB_TEST_MODE_TYPE_K,         
    HAL_USB_TEST_MODE_TYPE_SE0_NAK,   
    HAL_USB_TEST_MODE_TYPE_PACKET     
} hal_usb_test_mode_type_t;

typedef enum {
    HAL_USB_EP_DIRECTION_TX = 0,    
    HAL_USB_EP_DIRECTION_RX         
} hal_usb_endpoint_direction_t;

typedef enum {
    HAL_USB_EP_TRANSFER_CTRL = 0,   
    HAL_USB_EP_TRANSFER_BULK,       
    HAL_USB_EP_TRANSFER_INTR,       
    HAL_USB_EP_TRANSFER_ISO         
} hal_usb_endpoint_transfer_type_t;


typedef enum {
    HAL_USB_EP_STATE_DISABLE = 0,   
    HAL_USB_EP_STATE_FIFO,          
    HAL_USB_EP_STATE_DMA            
} hal_usb_endpoint_state_t;

typedef enum {
    HAL_USB_EP0_DRV_STATE_READ_END = 0,      
    HAL_USB_EP0_DRV_STATE_WRITE_RDY,         
    HAL_USB_EP0_DRV_STATE_TRANSACTION_END,   
    HAL_USB_EP0_DRV_STATE_CLEAR_SENT_STALL   
} hal_usb_endpoint_0_driver_state_t;


typedef enum {
    HAL_USB_DRV_HDLR_RESET = 0,  
    HAL_USB_DRV_HDLR_SUSPEND,    
    HAL_USB_DRV_HDLR_RESUME,     
    HAL_USB_DRV_HDLR_EP0,        
    HAL_USB_DRV_HDLR_EP_TX,      
    HAL_USB_DRV_HDLR_EP_RX       
} hal_usb_driver_handler_type_t;

typedef enum {
    HAL_USB_SET_ADDR_DATA = 0,
    HAL_USB_SET_ADDR_STATUS   
} hal_usb_set_address_state_t;
extern hal_usb_status_t hal_usb_init(void);
extern hal_usb_status_t hal_usb_configure_driver(void);

extern hal_usb_status_t hal_usb_register_driver_callback(hal_usb_driver_handler_type_t type, uint32_t ep_num, hal_usb_driver_interrupt_handler_t hdlr);
extern hal_usb_status_t hal_usb_pull_up_dp_line(void);
extern hal_usb_status_t hal_usb_reset_hardware(void);
extern hal_usb_status_t hal_usb_reset_fifo(void);
extern hal_usb_status_t hal_usb_deinit(void);
extern hal_usb_status_t hal_usb_set_address(uint8_t addr, hal_usb_set_address_state_t state);
extern hal_usb_status_t hal_usb_init_tx_endpoint(uint32_t ep_num, uint16_t data_size, hal_usb_endpoint_transfer_type_t type, bool double_fifo);
extern hal_usb_status_t hal_usb_init_rx_endpoint(uint32_t ep_num, uint16_t data_size, hal_usb_endpoint_transfer_type_t type, bool double_fifo);
extern hal_usb_status_t hal_usb_enable_tx_endpoint(uint32_t ep_num, hal_usb_endpoint_transfer_type_t ep_type, hal_usb_dma_usage_t dma_usage_type, bool is_flush);
extern hal_usb_status_t hal_usb_enable_rx_endpoint(uint32_t ep_num, hal_usb_endpoint_transfer_type_t ep_type, hal_usb_dma_usage_t dma_usage_type, bool is_flush);
extern hal_usb_status_t hal_usb_disable_tx_endpoint(uint32_t ep_num);
extern hal_usb_status_t hal_usb_disable_rx_endpoint(uint32_t ep_num);
extern hal_usb_status_t hal_usb_clear_tx_endpoint_data_toggle(uint32_t ep_num);
extern hal_usb_status_t hal_usb_clear_rx_endpoint_data_toggle(uint32_t ep_num);
extern hal_usb_status_t hal_usb_read_endpoint_fifo(uint32_t ep_num, uint16_t nBytes, void *pDst);
extern hal_usb_status_t hal_usb_write_endpoint_fifo(uint32_t ep_num, uint16_t nBytes, void *pSrc);
extern hal_usb_status_t hal_usb_set_endpoint_stall(uint32_t ep_num, hal_usb_endpoint_direction_t direction, bool stall_enable);
extern bool hal_usb_get_endpoint_stall_status(uint32_t ep_num, hal_usb_endpoint_direction_t direction);
extern hal_usb_status_t hal_usb_get_endpoint_0_status(bool *p_transaction_end, bool *p_sent_stall);
extern hal_usb_status_t hal_usb_update_endpoint_0_state(hal_usb_endpoint_0_driver_state_t state, bool stall, bool end);
extern uint32_t hal_usb_get_rx_packet_length(uint32_t ep_num);
extern hal_usb_status_t hal_usb_set_endpoint_tx_ready(uint32_t ep_num);
extern hal_usb_status_t hal_usb_set_endpoint_rx_ready(uint32_t ep_num);
extern hal_usb_status_t hal_usb_clear_tx_endpoint_fifo(uint32_t ep_num, hal_usb_endpoint_transfer_type_t ep_type, bool b_reset_toggle);
extern hal_usb_status_t hal_usb_clear_rx_endpoint_fifo(uint32_t ep_num, hal_usb_endpoint_transfer_type_t ep_type, bool b_reset_toggle);
extern hal_usb_status_t hal_usb_get_dma_channel(uint32_t ep_tx_num, uint32_t ep_rx_num, hal_usb_endpoint_direction_t direction, bool same_chan);
extern hal_usb_status_t hal_usb_release_dma_channel(uint32_t ep_tx_num, uint32_t ep_rx_num, hal_usb_endpoint_direction_t direction, bool same_chan);
extern hal_usb_status_t hal_usb_start_dma_channel(uint32_t ep_num, hal_usb_endpoint_direction_t direction, hal_usb_endpoint_transfer_type_t ep_type, void *addr, uint32_t length, hal_usb_dma_handler_t callback, bool callback_upd_run, hal_usb_dma_type_t dma_type);
extern hal_usb_status_t hal_usb_stop_dma_channel(uint32_t ep_num, hal_usb_endpoint_direction_t direction);
extern bool hal_usb_is_dma_running(uint32_t ep_num, hal_usb_endpoint_direction_t direction);
extern bool hal_usb_is_high_speed(void);
extern bool hal_usb_is_endpoint_tx_empty(uint32_t ep_num);
extern bool hal_usb_is_endpoint_rx_empty(uint32_t ep_num);
extern hal_usb_status_t hal_usb_enter_test_mode(hal_usb_test_mode_type_t test_selector);


#ifdef __cplusplus
}
#endif


#endif /* HAL_USB_MODULE_ENABLED */
#endif /* __HAL_USB_H__ */