hal_i2s.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_I2S_H__
#define __HAL_I2S_H__

#include "hal_platform.h"

#ifdef HAL_I2S_MODULE_ENABLED
#ifdef HAL_I2S_SUPPORT_VFIFO

#else

#endif //  #ifdef HAL_I2S_SUPPORT_VFIFO


#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
    HAL_I2S_STATUS_INVALID_PARAMETER  = -2,  
    HAL_I2S_STATUS_ERROR              = -1,  
    HAL_I2S_STATUS_OK                 =  0   
} hal_i2s_status_t;


typedef enum {
    HAL_I2S_MASTER  = 0,  
    HAL_I2S_SLAVE   = 1   
} hal_i2s_clock_mode_t;


typedef enum {
    HAL_I2S_MONO   = 0,   
    HAL_I2S_STEREO = 1    
} hal_i2s_channel_number_t;


typedef struct {
    hal_i2s_sample_rate_t           sample_rate;         
    hal_i2s_channel_number_t        channel_number;      
#ifdef HAL_I2S_EXTENDED
    uint32_t                        msb_offset;          
    hal_i2s_lr_swap_t               lr_swap;             
    hal_i2s_word_select_inverse_t   word_select_inverse; 
#endif
} hal_i2s_link_config_t;


typedef struct {
    hal_i2s_link_config_t        i2s_in;             
    hal_i2s_link_config_t        i2s_out;            
    hal_i2s_clock_mode_t         clock_mode;         
#ifdef HAL_I2S_FEATURE_TDM
    hal_i2s_tdm_channel_t        tdm_channel;        
#endif
#ifdef HAL_I2S_EXTENDED
    hal_i2s_frame_sync_width_t   frame_sync_width;   
    hal_i2s_sample_width_t       sample_width;       
    hal_i2s_tx_mode_t            tx_mode;            
    hal_i2s_rx_down_rate_t       rx_down_rate;      
#endif
} hal_i2s_config_t;


#ifdef HAL_I2S_SUPPORT_VFIFO

#else

#endif
typedef void (*hal_i2s_rx_callback_t)(hal_i2s_event_t event, void *user_data);


#ifdef HAL_I2S_SUPPORT_VFIFO

#else

#endif
typedef void (*hal_i2s_tx_callback_t)(hal_i2s_event_t event, void *user_data);



hal_i2s_status_t hal_i2s_init(hal_i2s_initial_type_t i2s_initial_type);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_init_ex(hal_i2s_port_t i2s_port, hal_i2s_initial_type_t i2s_initial_type);
#endif


hal_i2s_status_t hal_i2s_deinit(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_deinit_ex(hal_i2s_port_t i2s_port);
#endif


hal_i2s_status_t hal_i2s_set_config(const hal_i2s_config_t *config);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_set_config_ex(hal_i2s_port_t i2s_port, const hal_i2s_config_t *config);
#endif


hal_i2s_status_t hal_i2s_get_config(hal_i2s_config_t *config);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_get_config_ex(hal_i2s_port_t i2s_port, hal_i2s_config_t *config);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t  hal_i2s_enable_audio_top(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_enable_audio_top_ex(hal_i2s_port_t i2s_port);
#endif


hal_i2s_status_t  hal_i2s_disable_audio_top(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_disable_audio_top_ex(hal_i2s_port_t i2s_port);
#endif


#else

hal_i2s_status_t hal_i2s_get_memory_size(uint32_t *memory_size);


hal_i2s_status_t hal_i2s_set_memory(uint8_t *memory);


hal_i2s_status_t hal_i2s_get_memory_pointer(uint8_t **memory_pointer);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t  hal_i2s_enable_tx_dma_interrupt(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_enable_tx_dma_interrupt_ex(hal_i2s_port_t i2s_port);
#endif


hal_i2s_status_t  hal_i2s_disable_tx_dma_interrupt(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_disable_tx_dma_interrupt_ex(hal_i2s_port_t i2s_port);
#endif


hal_i2s_status_t  hal_i2s_enable_rx_dma_interrupt(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_enable_rx_dma_interrupt_ex(hal_i2s_port_t i2s_port);
#endif


hal_i2s_status_t  hal_i2s_disable_rx_dma_interrupt(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_disable_rx_dma_interrupt_ex(hal_i2s_port_t i2s_port);
#endif


hal_i2s_status_t hal_i2s_setup_tx_vfifo(uint32_t *buffer, uint32_t threshold, uint32_t buffer_length);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_setup_tx_vfifo_ex(hal_i2s_port_t i2s_port, uint32_t *buffer, uint32_t threshold, uint32_t buffer_length);
#endif


hal_i2s_status_t hal_i2s_stop_tx_vfifo(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_stop_tx_vfifo_ex(hal_i2s_port_t i2s_port);
#endif


hal_i2s_status_t hal_i2s_setup_rx_vfifo(uint32_t *buffer, uint32_t threshold, uint32_t buffer_length);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_setup_rx_vfifo_ex(hal_i2s_port_t i2s_port, uint32_t *buffer, uint32_t threshold, uint32_t buffer_length);
#endif


hal_i2s_status_t hal_i2s_stop_rx_vfifo(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_stop_rx_vfifo_ex(hal_i2s_port_t i2s_port);
#endif

#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t hal_i2s_register_rx_vfifo_callback(hal_i2s_rx_callback_t rx_callback, void *user_data);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_register_rx_vfifo_callback_ex(hal_i2s_port_t i2s_port, hal_i2s_rx_callback_t rx_callback, void *user_data);
#endif
#else

hal_i2s_status_t hal_i2s_register_rx_callback(hal_i2s_rx_callback_t rx_callback, void *user_data);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t hal_i2s_register_tx_vfifo_callback(hal_i2s_tx_callback_t tx_callback, void *user_data);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_register_tx_vfifo_callback_ex(hal_i2s_port_t i2s_port, hal_i2s_tx_callback_t tx_callback, void *user_data);
#endif
#else

hal_i2s_status_t hal_i2s_register_tx_callback(hal_i2s_tx_callback_t tx_callback, void *user_data);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t  hal_i2s_enable_tx(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_enable_tx_ex(hal_i2s_port_t i2s_port);
#endif
#else

hal_i2s_status_t  hal_i2s_enable_tx(void);
#endif


hal_i2s_status_t  hal_i2s_disable_tx(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_disable_tx_ex(hal_i2s_port_t i2s_port);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t hal_i2s_tx_write(uint32_t data);


#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_tx_write_ex(hal_i2s_port_t i2s_port, uint32_t data);
#endif

#else

hal_i2s_status_t hal_i2s_tx_write(const void *buffer, uint32_t sample_count);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

 hal_i2s_status_t hal_i2s_get_tx_sample_count(uint32_t *sample_count);

#ifdef  HAL_I2S_FEATURE_MULTI_I2S

 hal_i2s_status_t hal_i2s_get_tx_sample_count_ex(hal_i2s_port_t i2s_port, uint32_t *sample_count);
#endif
#else

 hal_i2s_status_t hal_i2s_get_tx_sample_count(uint32_t *sample_count);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t  hal_i2s_enable_rx(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t  hal_i2s_enable_rx_ex(hal_i2s_port_t i2s_port);
#endif
#else

hal_i2s_status_t  hal_i2s_enable_rx(void);
#endif


hal_i2s_status_t hal_i2s_disable_rx(void);
#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_disable_rx_ex(hal_i2s_port_t i2s_port);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t hal_i2s_rx_read(uint32_t *data);


#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_rx_read_ex(hal_i2s_port_t i2s_port, uint32_t *data);
#endif

#else

hal_i2s_status_t hal_i2s_rx_read(void *buffer, uint32_t sample_count);
#endif


#ifdef HAL_I2S_SUPPORT_VFIFO

hal_i2s_status_t hal_i2s_get_rx_sample_count(uint32_t *sample_count);

#ifdef  HAL_I2S_FEATURE_MULTI_I2S

hal_i2s_status_t hal_i2s_get_rx_sample_count_ex(hal_i2s_port_t i2s_port, uint32_t *sample_count);
#endif

#else

hal_i2s_status_t hal_i2s_get_rx_sample_count(uint32_t *sample_count);
#endif


#ifdef __cplusplus
}
#endif


#endif /*HAL_I2S_MODULE_ENABLED*/
#endif /* __HAL_I2S_H__ */