hal_i2c_master.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_I2C_MASTER_H__
#define __HAL_I2C_MASTER_H__
#include "hal_platform.h"

#ifdef HAL_I2C_MASTER_MODULE_ENABLED
#ifdef HAL_I2C_MASTER_FEATURE_EXTENDED_DMA

#else

#endif

#ifdef HAL_I2C_MASTER_FEATURE_EXTENDED_DMA

#endif

#ifdef __cplusplus
extern "C" {
#endif


/*****************************************************************************
* Enums
*****************************************************************************/

typedef enum {
    HAL_I2C_EVENT_ACK_ERROR = -3,           
    HAL_I2C_EVENT_NACK_ERROR = -2,          
    HAL_I2C_EVENT_TIMEOUT_ERROR = -1,       
    HAL_I2C_EVENT_SUCCESS = 0               
} hal_i2c_callback_event_t;


typedef enum {
    HAL_I2C_STATUS_ERROR = -4,                        
    HAL_I2C_STATUS_ERROR_BUSY = -3,                   
    HAL_I2C_STATUS_INVALID_PORT_NUMBER = -2,          
    HAL_I2C_STATUS_INVALID_PARAMETER = -1,            
    HAL_I2C_STATUS_OK = 0                             
} hal_i2c_status_t;

typedef enum {
    HAL_I2C_STATUS_IDLE = 0,                         
    HAL_I2C_STATUS_BUS_BUSY = 1                    
} hal_i2c_running_type_t;

typedef enum {
    HAL_I2C_FREQUENCY_50K  = 0,          
    HAL_I2C_FREQUENCY_100K = 1,          
    HAL_I2C_FREQUENCY_200K = 2,          
    HAL_I2C_FREQUENCY_300K = 3,          
    HAL_I2C_FREQUENCY_400K = 4,          
    HAL_I2C_FREQUENCY_1M   = 5,          
    HAL_I2C_FREQUENCY_MAX                
} hal_i2c_frequency_t;

/*****************************************************************************
* Structures
*****************************************************************************/

typedef struct {
    hal_i2c_frequency_t frequency;             
} hal_i2c_config_t;

typedef struct {
    hal_i2c_running_type_t running_status;   
} hal_i2c_running_status_t;

#ifdef HAL_I2C_MASTER_FEATURE_SEND_TO_RECEIVE

typedef struct {
    uint8_t slave_address;                     
    const uint8_t *send_data;                  
    uint32_t send_length;                      
    uint8_t *receive_buffer;                   
    uint32_t receive_length;                   
} hal_i2c_send_to_receive_config_t;
#endif

#ifdef HAL_I2C_MASTER_FEATURE_EXTENDED_DMA

typedef struct {
    uint8_t slave_address;                     
    const uint8_t *send_data;                  
    uint32_t send_packet_length;               
    uint32_t send_bytes_in_one_packet;         
} hal_i2c_send_config_t;

typedef struct {
    uint8_t slave_address;                     
    uint8_t *receive_buffer;                   
    uint32_t receive_packet_length;            
    uint32_t receive_bytes_in_one_packet;      
} hal_i2c_receive_config_t;

typedef struct {
    uint8_t slave_address;                     
    const uint8_t *send_data;                  
    uint8_t *receive_buffer;                   
    uint32_t send_packet_length;               
    uint32_t send_bytes_in_one_packet;         
    uint32_t receive_packet_length;            
    uint32_t receive_bytes_in_one_packet;      
} hal_i2c_send_to_receive_config_ex_t;

#endif


typedef void (*hal_i2c_callback_t)(uint8_t slave_address, hal_i2c_callback_event_t event, void *user_data);

/*****************************************************************************
* Functions
*****************************************************************************/


hal_i2c_status_t hal_i2c_master_init(hal_i2c_port_t i2c_port, hal_i2c_config_t *i2c_config);


hal_i2c_status_t hal_i2c_master_deinit(hal_i2c_port_t i2c_port);


hal_i2c_status_t hal_i2c_master_set_frequency(hal_i2c_port_t i2c_port, hal_i2c_frequency_t frequency);




hal_i2c_status_t hal_i2c_master_register_callback(hal_i2c_port_t i2c_port, hal_i2c_callback_t i2c_callback, void *user_data);


hal_i2c_status_t hal_i2c_master_send_polling(hal_i2c_port_t i2c_port, uint8_t slave_address, const uint8_t *data, uint32_t size);


hal_i2c_status_t hal_i2c_master_send_dma(hal_i2c_port_t i2c_port, uint8_t slave_address, const uint8_t *data, uint32_t size);


hal_i2c_status_t hal_i2c_master_receive_polling(hal_i2c_port_t i2c_port, uint8_t slave_address, uint8_t *buffer, uint32_t size);



hal_i2c_status_t hal_i2c_master_receive_dma(hal_i2c_port_t i2c_port, uint8_t slave_address, uint8_t  *buffer, uint32_t size);


#ifdef HAL_I2C_MASTER_FEATURE_SEND_TO_RECEIVE

hal_i2c_status_t hal_i2c_master_send_to_receive_polling(hal_i2c_port_t i2c_port, hal_i2c_send_to_receive_config_t *i2c_send_to_receive_config);



hal_i2c_status_t hal_i2c_master_send_to_receive_dma(hal_i2c_port_t i2c_port, hal_i2c_send_to_receive_config_t *i2c_send_to_receive_config);

#endif /* #ifdef HAL_I2C_MASTER_FEATURE_SEND_TO_RECEIVE */

#ifdef HAL_I2C_MASTER_FEATURE_EXTENDED_DMA

hal_i2c_status_t hal_i2c_master_send_dma_ex(hal_i2c_port_t i2c_port, hal_i2c_send_config_t *i2c_send_config);

hal_i2c_status_t hal_i2c_master_receive_dma_ex(hal_i2c_port_t i2c_port, hal_i2c_receive_config_t *i2c_receive_config);

hal_i2c_status_t hal_i2c_master_send_to_receive_dma_ex(hal_i2c_port_t i2c_port, hal_i2c_send_to_receive_config_ex_t *i2c_send_to_receive_config_ex);

#endif


hal_i2c_status_t hal_i2c_master_get_running_status(hal_i2c_port_t i2c_port, hal_i2c_running_status_t *running_status);


#ifdef __cplusplus
}
#endif

#endif /*HAL_I2C_MASTER_MODULE_ENABLED*/
#endif /* __HAL_I2C_MASTER_H__ */