rtc2.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 RTC2_H
#define RTC2_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 RTC2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define RTC2_RETVAL  uint8_t
 
#define RTC2_OK           0x00
#define RTC2_INIT_ERROR   0xFF
#define RTC2_I2C_ADDRESS                                           0x68
#define RTC2_REG_TIME_SEC                                          0x00
#define RTC2_REG_TIME_MIN                                          0x01
#define RTC2_REG_TIME_HOUR                                         0x02
#define RTC2_REG_TIME_DAY_OF_THE_WEEK                              0x03
#define RTC2_REG_TIME_DATE_DAY                                     0x04
#define RTC2_REG_TIME_DATE_MONTH                                   0x05
#define RTC2_REG_TIME_DATE_YEAR                                    0x06
#define RTC2_REG_CONTROL                                           0x07
#define RTC2_ENABLE_COUNTING                                       0x7F
#define RTC2_DISABLE_COUNTING                                      0x80
#define RTC2_CONFIG_RATE_LOW                                       0x00
#define RTC2_CONFIG_RATE_HIGH                                      0x80
#define RTC2_CONFIG_RATE_SELECT_1_HZ                               0x10
#define RTC2_CONFIG_RATE_SELECT_4_096_kHZ                          0x11
#define RTC2_CONFIG_RATE_SELECT_8_192_kHZ                          0x12
#define RTC2_CONFIG_RATE_SELECT_32_768_kHZ                         0x13
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} rtc2_t;
 
typedef struct
{
    uint8_t day_of_the_week;
    uint8_t date_day;
    uint8_t date_month;
    uint16_t date_year;
} rtc2_data_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;
 
} rtc2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rtc2_cfg_setup ( rtc2_cfg_t *cfg );
 
RTC2_RETVAL rtc2_init ( rtc2_t *ctx, rtc2_cfg_t *cfg );
 
void rtc2_generic_write ( rtc2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void rtc2_generic_read ( rtc2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
 uint8_t rtc2_read_byte ( rtc2_t *ctx, uint8_t reg_address );
 
 void rtc2_write_byte ( rtc2_t *ctx, uint8_t reg_address, uint8_t write_data );
 
 void rtc2_enable_counting ( rtc2_t *ctx );
 
 void rtc2_disable_counting ( rtc2_t *ctx );
 
 uint8_t rtc2_get_time_seconds ( rtc2_t *ctx ) ;
 
 void rtc2_set_time_seconds ( rtc2_t *ctx, uint8_t seconds );
 
 uint8_t rtc2_get_time_minutes ( rtc2_t *ctx );
 
 void rtc2_set_time_minutes ( rtc2_t *ctx, uint8_t minutes );
 
 uint8_t rtc2_get_time_hours ( rtc2_t *ctx );
 
 void rtc2_set_time_hours ( rtc2_t *ctx, uint8_t hours );
 
 uint8_t rtc2_get_day_of_the_week ( rtc2_t *ctx );
 
 void rtc2_set_day_of_the_week ( rtc2_t *ctx, uint8_t w_day );
 
 uint8_t rtc2_get_date_day ( rtc2_t *ctx );
 
 void rtc2_set_date_day ( rtc2_t *ctx, uint8_t date_day );
 
 uint8_t rtc2_get_date_month ( rtc2_t *ctx );
 
 void rtc2_set_date_month ( rtc2_t *ctx, uint8_t date_month );
 
 uint8_t rtc2_get_date_year ( rtc2_t *ctx );
 
 void rtc2_set_date_year ( rtc2_t *ctx, uint16_t date_year );
 
 void rtc2_set_time ( rtc2_t *ctx, uint8_t time_hours, uint8_t time_minutes, uint8_t time_seconds );
 
 void rtc2_get_time ( rtc2_t *ctx, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds );
 
 void rtc2_set_date ( rtc2_t *ctx, rtc2_data_t *date );
 
 void rtc2_get_date ( rtc2_t *ctx, rtc2_data_t *date );
 
 void rtc2_set_frequency_sqwe ( rtc2_t *ctx, uint8_t rate_select );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _RTC2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END