rtc19.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 RTC19_H
#define RTC19_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 RTC19_REG_STATUS                    0x00
#define RTC19_REG_INT_EN                    0x01
#define RTC19_REG_RTC_RESET                 0x02
#define RTC19_REG_RTC_CONFIG1               0x03
#define RTC19_REG_RTC_CONFIG2               0x04
#define RTC19_REG_TIMESTAMP_CONFIG          0x05
#define RTC19_REG_TIMER_CONFIG              0x06
#define RTC19_REG_SLEEP_CONFIG              0x07
#define RTC19_REG_SECONDS_1_128             0x08
#define RTC19_REG_SECONDS                   0x09
#define RTC19_REG_MINUTES                   0x0A
#define RTC19_REG_HOURS                     0x0B
#define RTC19_REG_DAY                       0x0C
#define RTC19_REG_DATE                      0x0D
#define RTC19_REG_MONTH                     0x0E
#define RTC19_REG_YEAR                      0x0F
#define RTC19_REG_ALM1_SEC                  0x10
#define RTC19_REG_ALM1_MIN                  0x11
#define RTC19_REG_ALM1_HRS                  0x12
#define RTC19_REG_ALM1_DAY_DATE             0x13
#define RTC19_REG_ALM1_MON                  0x14
#define RTC19_REG_ALM1_YEAR                 0x15
#define RTC19_REG_ALM2_MIN                  0x16
#define RTC19_REG_ALM2_HRS                  0x17
#define RTC19_REG_ALM2_DAY_DATE             0x18
#define RTC19_REG_TIMER_COUNT2              0x19
#define RTC19_REG_TIMER_COUNT1              0x1A
#define RTC19_REG_TIMER_INIT2               0x1B
#define RTC19_REG_TIMER_INIT1               0x1C
#define RTC19_REG_PWR_MGMT                  0x1D
#define RTC19_REG_TRICKLE_REG               0x1E
#define RTC19_REG_OFFSET_HIGH               0x20
#define RTC19_REG_OFFSET_LOW                0x21
 
#define RTC19_REG_TS0_SEC_1_128             0x30
#define RTC19_REG_TS0_SEC                   0x31
#define RTC19_REG_TS0_MIN                   0x32
#define RTC19_REG_TS0_HOUR                  0x33
#define RTC19_REG_TS0_DATE                  0x34
#define RTC19_REG_TS0_MONTH                 0x35
#define RTC19_REG_TS0_YEAR                  0x36
#define RTC19_REG_TS0_FLAGS                 0x37
#define RTC19_REG_TS1_SEC_1_128             0x38
#define RTC19_REG_TS1_SEC                   0x39
#define RTC19_REG_TS1_MIN                   0x3A
#define RTC19_REG_TS1_HOUR                  0x3B
#define RTC19_REG_TS1_DATE                  0x3C
#define RTC19_REG_TS1_MONTH                 0x3D
#define RTC19_REG_TS1_YEAR                  0x3E
#define RTC19_REG_TS1_FLAGS                 0x3F
#define RTC19_REG_TS2_SEC_1_128             0x40
#define RTC19_REG_TS2_SEC                   0x41
#define RTC19_REG_TS2_MIN                   0x42
#define RTC19_REG_TS2_HOUR                  0x43
#define RTC19_REG_TS2_DATE                  0x44
#define RTC19_REG_TS2_MONTH                 0x45
#define RTC19_REG_TS2_YEAR                  0x46
#define RTC19_REG_TS2_FLAGS                 0x47
#define RTC19_REG_TS3_SEC_1_128             0x48
#define RTC19_REG_TS3_SEC                   0x49
#define RTC19_REG_TS3_MIN                   0x4A
#define RTC19_REG_TS3_HOUR                  0x4B
#define RTC19_REG_TS3_DATE                  0x4C
#define RTC19_REG_TS3_MONTH                 0x4D
#define RTC19_REG_TS3_YEAR                  0x4E
#define RTC19_REG_TS3_FLAGS                 0x4F
 
 // rtc19_reg
 
#define RTC19_RTC_RESET_CLEAR               0x00
#define RTC19_RTC_RESET_SET                 0x01
 
#define RTC19_INT_EN_DOSF                   0x40
#define RTC19_INT_EN_PFAILE                 0x20
#define RTC19_INT_EN_VBATLOWIE              0x10
#define RTC19_INT_EN_DIE                    0x08
#define RTC19_INT_EN_TIE                    0x04
#define RTC19_INT_EN_A2IE                   0x02
#define RTC19_INT_EN_A1IE                   0x01
 
#define RTC19_TIMER_CONFIG_TE               0x10
#define RTC19_TIMER_CONFIG_TPAUSE           0x08
#define RTC19_TIMER_CONFIG_TRPT             0x04
#define RTC19_TIMER_CONFIG_TFS_1024HZ       0x00
#define RTC19_TIMER_CONFIG_TFS_256HZ        0x01
#define RTC19_TIMER_CONFIG_TFS_64HZ         0x02
#define RTC19_TIMER_CONFIG_TFS_16HZ         0x03
#define RTC19_TIMER_CONFIG_TFS_MASK         0x03
 
#define RTC19_TIMER_INIT_16CNT              0x000F
 
#define RTC19_MONDAY                        0x01
#define RTC19_TUESDAY                       0x02
#define RTC19_WEDNESDAY                     0x03
#define RTC19_THURSDAY                      0x04
#define RTC19_FRIDAY                        0x05
#define RTC19_SATURDAY                      0x06
#define RTC19_SUNDAY                        0x07
 
#define RTC19_DEVICE_ADDRESS                0x68
 
 // rtc19_set
 
#define RTC19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.psw = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.intb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.din = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.inta = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc19_map
 // rtc19
 
typedef struct
{
    // Output pins
    digital_out_t din;          
    // Input pins
    digital_in_t psw;           
    digital_in_t intb;          
    digital_in_t inta;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} rtc19_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t psw;             
    pin_name_t intb;            
    pin_name_t din;             
    pin_name_t inta;            
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} rtc19_cfg_t;
 
typedef struct
{
    uint16_t sub_second;
    uint8_t second;
    uint8_t minute;
    uint8_t hour;
 
} rtc19_time_t;
 
typedef struct
{
    uint8_t day_of_week;
    uint8_t day;
    uint8_t month;
    uint8_t year;
 
} rtc19_date_t;
 
typedef enum
{
    RTC19_OK = 0,
    RTC19_ERROR = -1
 
} rtc19_return_value_t;
 
void rtc19_cfg_setup ( rtc19_cfg_t *cfg );
 
err_t rtc19_init ( rtc19_t *ctx, rtc19_cfg_t *cfg );
 
err_t rtc19_default_cfg ( rtc19_t *ctx );
 
err_t rtc19_generic_write ( rtc19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t rtc19_generic_read ( rtc19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t rtc19_write_register ( rtc19_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t rtc19_read_register ( rtc19_t *ctx, uint8_t reg, uint8_t *data_out );
 
void rtc19_set_din_pin ( rtc19_t *ctx, uint8_t state );
 
uint8_t rtc19_get_psw_pin ( rtc19_t *ctx );
 
uint8_t rtc19_get_inta_pin ( rtc19_t *ctx );
 
uint8_t rtc19_get_intb_pin ( rtc19_t *ctx );
 
err_t rtc19_set_time ( rtc19_t *ctx, rtc19_time_t *time );
 
err_t rtc19_read_time ( rtc19_t *ctx, rtc19_time_t *time );
 
err_t rtc19_set_date ( rtc19_t *ctx, rtc19_date_t *date );
 
err_t rtc19_read_date ( rtc19_t *ctx, rtc19_date_t *date );
 
err_t rtc19_reset_device ( rtc19_t *ctx );
 
err_t rtc19_clear_interrupts ( rtc19_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // RTC19_H
 
 // rtc19
 
// ------------------------------------------------------------------------ END