rtc.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 RTC_C_H
#define RTC_C_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 RTC_C_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ); 
#define RTC_C_OK                                          0
#define RTC_C_ERROR                                      -1
#define RTC_C_I2C_ADDRESS_0                               0x50
#define RTC_C_I2C_ADDRESS_1                               0x51
#define RTC_C_REG_CONTROL                                 0x00
#define RTC_C_REG_TIME_HUN_SEC                            0x01
#define RTC_C_REG_TIME_SEC                                0x02
#define RTC_C_REG_TIME_MIN                                0x03
#define RTC_C_REG_TIME_HOUR                               0x04
#define RTC_C_REG_TIME_DATE_DAY_AND_YEAR                  0x05
#define RTC_C_REG_TIME_DAY_OF_THE_WEEK_AND_MONTH          0x06
#define RTC_C_REG_TIMER                                   0x07
#define RTC_C_REG_TIME_ALARM_CONTROL                      0x08
#define RTC_C_REG_TIME_ALARM_HUN_SEC                      0x09
#define RTC_C_REG_TIME_ALARM_SEC                          0x0A
#define RTC_C_REG_TIME_ALARM_MIN                          0x0B
#define RTC_C_REG_TIME_ALARM_HOUR                         0x0C
#define RTC_C_REG_TIME_ALARM_DATE_DAY_AND_YEAR            0x0D
#define RTC_C_REG_TIME_ALARM_DAY_OF_THE_WEEK_AND_MONTH    0x0E
#define RTC_C_REG_TIME_ALARM_TIMER                        0x0F
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    uint8_t day_of_the_week;
    uint8_t date_day;
    uint8_t date_month;
    uint16_t date_year;
 
} rtc_c_date_t;
 
typedef struct
{
    uint8_t time_hours;
    uint8_t time_minutes;
    uint8_t time_seconds;
    int8_t time_hun_sec;
 
} rtc_c_time_t;
 
typedef struct
{
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
    i2c_master_t i2c;
 
    // I2C slave address
    uint8_t slave_address;      
    // time and date data
    rtc_c_date_t date;
    rtc_c_time_t time;
 
} rtc_c_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;     
} rtc_c_cfg_t;
 
 
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rtc_c_cfg_setup ( rtc_c_cfg_t *cfg );
 
err_t rtc_c_init ( rtc_c_t *ctx, rtc_c_cfg_t *cfg );
 
err_t rtc_c_generic_write ( rtc_c_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t rtc_c_generic_read ( rtc_c_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void rtc_c_enable_disable_counting ( rtc_c_t *ctx, uint8_t en_dis );
 
void rtc_c_read_time ( rtc_c_t *ctx );
 
void rtc_c_read_date ( rtc_c_t *ctx );
 
uint8_t rtc_c_get_time_value ( rtc_c_t *ctx, uint8_t time_part );
 
void rtc_c_set_time_value ( rtc_c_t *ctx, uint8_t time_part, uint8_t time_addr );
 
uint8_t rtc_c_get_date_day ( rtc_c_t *ctx );
 
void rtc_c_set_date_day ( rtc_c_t *ctx, uint8_t date_day );
 
uint8_t rtc_c_get_date_year ( rtc_c_t *ctx );
 
void rtc_c_set_date_year ( rtc_c_t *ctx, uint16_t date_year );
 
uint8_t rtc_c_check_leap_year ( rtc_c_t *ctx );
 
uint8_t rtc_c_get_day_of_the_week ( rtc_c_t *ctx );
 
void rtc_c_set_day_of_the_week ( rtc_c_t *ctx, uint8_t w_day );
 
uint8_t rtc_c_get_date_month ( rtc_c_t *ctx );
 
void rtc_c_set_date_month ( rtc_c_t *ctx, uint8_t date_month );
 
void rtc_c_set_time ( rtc_c_t *ctx );
 
void rtc_c_get_time ( rtc_c_t *ctx );
 
void rtc_c_set_date ( rtc_c_t *ctx );
 
void rtc_c_get_date ( rtc_c_t *ctx );
 
void rtc_c_enable_disable_alarm ( rtc_c_t *ctx, uint8_t en_dis );
 
void rtc_c_set_alarm_value ( rtc_c_t *ctx, uint8_t al_time_val, uint8_t al_time_type );
 
uint8_t rtc_c_get_alarm_value ( rtc_c_t *ctx, uint8_t alarm_addr );
 
void rtc_c_set_time_alarm ( rtc_c_t *ctx );
 
void rtc_c_get_time_alarm ( rtc_c_t *ctx );
 
void rtc_c_enable_disable_interrupt( rtc_c_t *ctx, uint8_t flag );
 
uint8_t rtc_c_get_interrupt( rtc_c_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _RTC_C_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END