antopwm2.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 ANTOPWM2_H
#define ANTOPWM2_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_i2c_master.h"
 
#define ANTOPWM2_OTP_BIT                0x80
#define ANTOPWM2_STATUS_READY           0x00
#define ANTOPWM2_STATUS_TEST_FUSE       0x40
#define ANTOPWM2_STATUS_FATAL_ERROR     0x80
#define ANTOPWM2_STATUS_OTP_SUCCESS     0xC0
#define ANTOPWM2_STATUS_MASK            0xC0
 
#define ANTOPWM2_DIGIPOT_WIPER_MAX      0x3F
#define ANTOPWM2_DIGIPOT_R6             49900u
#define ANTOPWM2_DIGIPOT_WIPER_RES      60
#define ANTOPWM2_DIGIPOT_MAX_RES        50000u
 
#define ANTOPWM2_FREQ_MAX               1000000ul
#define ANTOPWM2_FREQ_MIN               500000ul
#define ANTOPWM2_RSET_REF               50000u
#define ANTOPWM2_NDIV                   1
 
#define ANTOPWM2_DEVICE_ADDRESS         0x2C
 
 // antopwm2_set
 
#define ANTOPWM2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // antopwm2_map
 // antopwm2
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} antopwm2_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t int_pin;         
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} antopwm2_cfg_t;
 
typedef enum
{
    ANTOPWM2_OK = 0,
    ANTOPWM2_ERROR = -1
 
} antopwm2_return_value_t;
 
void antopwm2_cfg_setup ( antopwm2_cfg_t *cfg );
 
err_t antopwm2_init ( antopwm2_t *ctx, antopwm2_cfg_t *cfg );
 
err_t antopwm2_set_digipot ( antopwm2_t *ctx, uint8_t wiper );
 
err_t antopwm2_read_digipot ( antopwm2_t *ctx, uint8_t *data_out );
 
err_t antopwm2_set_digipot_otp ( antopwm2_t *ctx, uint8_t wiper );
 
err_t antopwm2_set_frequency ( antopwm2_t *ctx, uint32_t freq );
 
err_t antopwm2_set_frequency_otp ( antopwm2_t *ctx, uint32_t freq );
 
uint8_t antopwm2_get_int_pin ( antopwm2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ANTOPWM2_H
 
 // antopwm2
 
// ------------------------------------------------------------------------ END