hal_i2c_master.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2022 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
#ifndef _HAL_I2C_MASTER_H_
#define _HAL_I2C_MASTER_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdbool.h>
#include <stdint.h>
#include "hal_target.h"
 
typedef struct
{
    handle_t *hal_i2c_master_handle; 
    handle_t *drv_i2c_master_handle; 
    bool      init_state;            
} hal_i2c_master_handle_register_t;
 
typedef enum
{
    HAL_I2C_MASTER_SUCCESS = 0,  
    HAL_I2C_MASTER_WRONG_PINS,   
    HAL_I2C_MASTER_MODULE_ERROR, 
    HAL_I2C_MASTER_ERROR = (-1) 
} hal_i2c_master_err_t;
 
typedef enum
{
    HAL_I2C_MASTER_TIMEOUT_START = 1300, 
    HAL_I2C_MASTER_TIMEOUT_STOP,         
    HAL_I2C_MASTER_TIMEOUT_WRITE,        
    HAL_I2C_MASTER_TIMEOUT_READ,         
    HAL_I2C_MASTER_ARBITRATION_LOST,     
    HAL_I2C_MASTER_TIMEOUT_INIT          
} hal_i2c_master_timeout_t;
 
typedef enum
{
    HAL_I2C_MASTER_SPEED_STANDARD = 0, 
    HAL_I2C_MASTER_SPEED_FULL,         
    HAL_I2C_MASTER_SPEED_FAST          
} hal_i2c_master_speed_t;
 
typedef struct
{
    uint8_t addr; 
    hal_pin_name_t sda; 
    hal_pin_name_t scl; 
    uint32_t speed; 
    uint16_t
        timeout_pass_count; 
} hal_i2c_master_config_t;
 
typedef struct
{
    handle_t                handle; 
    hal_i2c_master_config_t config; 
} hal_i2c_master_t;
 
err_t hal_i2c_master_open(handle_t *handle, bool hal_obj_open_state);
 
void hal_i2c_master_set_slave_address(handle_t *handle, hal_i2c_master_config_t *config);
 
err_t hal_i2c_master_write(handle_t handle, uint8_t *write_data_buf, size_t len_write_data);
 
err_t hal_i2c_master_read(handle_t handle, uint8_t *read_data_buf, size_t len_read_data);
 
err_t hal_i2c_master_write_then_read(handle_t handle,
                                     uint8_t *write_data_buf,
                                     size_t   len_write_data,
                                     uint8_t *read_data_buf,
                                     size_t   len_read_data);
 
err_t hal_i2c_master_close(handle_t *handle);
 
/*---------------------Unused Functions--------------------------------*/
 
void hal_i2c_master_configure_default(hal_i2c_master_config_t *config);
 
err_t hal_i2c_master_set_speed(handle_t *handle, hal_i2c_master_config_t *config);
 
void hal_i2c_master_set_timeout(handle_t *handle, hal_i2c_master_config_t *config);
 
#ifdef __cplusplus
}
#endif
 
#endif // _HAL_I2C_MASTER_H_
// ------------------------------------------------------------------------- END