c1wirei2c.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** 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,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, 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 C1WIREI2C_H
#define C1WIREI2C_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_one_wire.h"
 
#define C1WIREI2C_CMD_WRITE_DATA_WITH_STOP      0x4B
#define C1WIREI2C_CMD_WRITE_DATA_NO_STOP        0x5A
#define C1WIREI2C_CMD_WRITE_DATA_ONLY           0x69
#define C1WIREI2C_CMD_WRITE_DATA_ONLY_WITH_STOP 0x78
#define C1WIREI2C_CMD_READ_DATA_WITH_STOP       0x87
#define C1WIREI2C_CMD_WRITE_READ_DATA_WITH_STOP 0x2D
#define C1WIREI2C_CMD_WRITE_CONFIGURATION       0xD2
#define C1WIREI2C_CMD_READ_CONFIGURATION        0xE1
#define C1WIREI2C_CMD_ENABLE_SLEEP_MODE         0x1E
#define C1WIREI2C_CMD_READ_DEVICE_REVISION      0xC3
 
 // c1wirei2c_cmd
 
#define C1WIREI2C_CONFIGURATION_SPD_100KHZ      0x00
#define C1WIREI2C_CONFIGURATION_SPD_400KHZ      0x01
#define C1WIREI2C_CONFIGURATION_SPD_900KHZ      0x02
#define C1WIREI2C_CONFIGURATION_SPD_MASK        0x03
 
#define C1WIREI2C_FAMILY_CODE                   0x19
 
#define C1WIREI2C_ADDRESS_0                     0x00
#define C1WIREI2C_ADDRESS_ALL                   0xFF
 
 // c1wirei2c_set
 
#define C1WIREI2C_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.ow2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ow1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
 
 // c1wirei2c_map
 // c1wirei2c
 
typedef enum
{
    C1WIREI2C_GPIO_OW1,                 
    C1WIREI2C_GPIO_OW2                  
} c1wirei2c_gpio_sel_t;
 
typedef struct
{
    // Output pins
    digital_out_t rst;                  
    // Modules
    one_wire_t ow;                      
    one_wire_rom_address_t rom_addr;    
    uint8_t address;                    
} c1wirei2c_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t ow1;                     
    pin_name_t ow2;                     
    // Additional gpio pins
    pin_name_t rst;                     
    c1wirei2c_gpio_sel_t gpio_sel;      
} c1wirei2c_cfg_t;
 
typedef enum
{
    C1WIREI2C_OK = 0,
    C1WIREI2C_ERROR = -1
 
} c1wirei2c_return_value_t;
 
void c1wirei2c_cfg_setup ( c1wirei2c_cfg_t *cfg );
 
void c1wirei2c_gpio_selection ( c1wirei2c_cfg_t *cfg, c1wirei2c_gpio_sel_t gpio_sel );
 
err_t c1wirei2c_init ( c1wirei2c_t *ctx, c1wirei2c_cfg_t *cfg );
 
err_t c1wirei2c_default_cfg ( c1wirei2c_t *ctx );
 
err_t c1wirei2c_check_communication ( c1wirei2c_t *ctx );
 
err_t c1wirei2c_select_device ( c1wirei2c_t *ctx );
 
err_t c1wirei2c_write_data_stop ( c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len );
 
err_t c1wirei2c_write_data ( c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_in, uint8_t len );
 
err_t c1wirei2c_write_data_only ( c1wirei2c_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t c1wirei2c_write_data_only_stop ( c1wirei2c_t *ctx, uint8_t *data_in, uint8_t len );
 
err_t c1wirei2c_read_data_stop ( c1wirei2c_t *ctx, uint8_t slave_addr, uint8_t *data_out, uint8_t len );
 
err_t c1wirei2c_write_read_data_stop ( c1wirei2c_t *ctx, uint8_t slave_addr, 
                                       uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len );
 
err_t c1wirei2c_write_configuration ( c1wirei2c_t *ctx, uint8_t config );
 
err_t c1wirei2c_read_configuration ( c1wirei2c_t *ctx, uint8_t *config );
 
err_t c1wirei2c_enable_sleep_mode ( c1wirei2c_t *ctx );
 
err_t c1wirei2c_read_device_revision ( c1wirei2c_t *ctx, uint8_t *revision );
 
void c1wirei2c_set_rst_pin ( c1wirei2c_t *ctx, uint8_t state );
 
void c1wirei2c_reset_device ( c1wirei2c_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // C1WIREI2C_H
 
 // c1wirei2c
 
// ------------------------------------------------------------------------ END