rtc3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 RTC3_H
#define RTC3_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define RTC3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define RTC3_I2C_ADDRESS                                            0x68
#define RTC3_REG_TIME_SEC                                           0x00
#define RTC3_REG_TIME_MIN                                           0x01
#define RTC3_REG_TIME_HOUR                                          0x02
#define RTC3_REG_TIME_DAY_OF_THE_WEEK                               0x03
#define RTC3_REG_TIME_DATE_DAY                                      0x04
#define RTC3_REG_TIME_DATE_MONTH                                    0x05
#define RTC3_REG_TIME_DATE_YEAR                                     0x06
#define RTC3_REG_CONFIG1                                            0x07
#define RTC3_REG_TRICKLE_CHARGE2                                    0x08
#define RTC3_REG_CONFIG2                                            0x09
#define RTC3_REG_SF_KEY1                                            0x20
#define RTC3_REG_SF_KEY2                                            0x21
#define RTC3_REG_SFR                                                0x22
#define RTC3_ENABLE_COUNTING                                        0x7F
#define RTC3_DISABLE_COUNTING                                       0x80
#define RTC3_CONFIG1_INITIAL                                        0x80
#define RTC3_TCH2_OPEN                                              0x00
#define RTC3_TCH2_CLOSED                                            0x20
#define RTC3_TCFE_OPEN                                              0x00
#define RTC3_TCFE_CLOSED                                            0x20
#define RTC3_FTF_NORMAL_512_HZ                                      0x00
#define RTC3_FTF_1_HZ                                               0x01
#define RTC3_OK                                                     0
#define RTC3_ERROR                                                 -1
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    uint8_t day_of_the_week;
    uint8_t date_day;
    uint8_t date_month;
    uint8_t date_year;
 
} date_data_t;
 
typedef struct
{
    uint8_t time_hours;
    uint8_t time_minutes;
    uint8_t time_seconds;
 
} time_data_t;
 
typedef struct
{
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
    i2c_master_t i2c;
 
    // ctx variable 
    uint8_t slave_address;
    
    // time and date data
    date_data_t date;
    time_data_t time;
 
} rtc3_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
    pin_name_t int_pin;
 
    // static variable 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} rtc3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rtc3_cfg_setup ( rtc3_cfg_t *cfg );
 
err_t rtc3_init ( rtc3_t *ctx, rtc3_cfg_t *cfg );
 
void rtc3_generic_write ( rtc3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void rtc3_generic_read ( rtc3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void rtc3_set_counting ( rtc3_t *ctx, uint8_t en_dis );
 
void rtc3_set_time ( rtc3_t *ctx );
 
void rtc3_get_time ( rtc3_t *ctx );
 
void rtc3_set_date ( rtc3_t *ctx );
 
void rtc3_get_date ( rtc3_t *ctx );
 
void rtc3_set_calibration ( rtc3_t *ctx, uint8_t cal_sign, uint8_t cal_mumber );
 
void rtc3_set_trickle_charge ( rtc3_t *ctx, uint8_t tch2 );
 
void rtc3_set_trickle_charge_bypass ( rtc3_t *ctx, uint8_t tcfe );
 
void rtc3_set_special_function_key1 ( rtc3_t *ctx, uint8_t sfkey1 );
 
void rtc3_set_special_function_key2 ( rtc3_t *ctx, uint8_t sfkey2 );
 
void rtc3_set_frequency_calibration ( rtc3_t *ctx, uint8_t ftf );
 
uint8_t rtc3_get_interrupt( rtc3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _RTC3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END