rtc9.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 RTC9_H
#define RTC9_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 RTC9_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
#define RTC9_RETVAL  uint8_t
 
#define RTC9_OK           0x00
#define RTC9_INIT_ERROR   0xFF
#define RTC9_SLAVE_ADDRESS             0x68
#define RTC9_REG_PART_SECONDS          0x00
#define RTC9_REG_SECONDS               0x01
#define RTC9_REG_MINUTES               0x02
#define RTC9_REG_CENTURY_HOURS         0x03
#define RTC9_REG_DAY                   0x04
#define RTC9_REG_DATE                  0x05
#define RTC9_REG_MONTH                 0x06
#define RTC9_REG_YEAR                  0x07
#define RTC9_REG_DIGITAL_CALIBRATION   0x08
#define RTC9_REG_WATCHDOG              0x09
#define RTC9_REG_ALARM1_MONTH          0x0A
#define RTC9_REG_ALARM1_DATE           0x0B
#define RTC9_REG_ALARM1_HOUR           0x0C
#define RTC9_REG_ALARM1_MINUTES        0x0D
#define RTC9_REG_ALARM1_SECONDS        0x0E
#define RTC9_REG_FLAGS                 0x0F
#define RTC9_REG_TIMER_VALUE           0x10
#define RTC9_REG_TIMER_CONTROL         0x11
#define RTC9_REG_ANALOG_CALIBRATION    0x12
#define RTC9_REG_SQW                   0x13
#define RTC9_REG_ALARM2_MONTH          0x14
#define RTC9_REG_ALARM2_DATE           0x15
#define RTC9_REG_ALARM2_HOUR           0x16
#define RTC9_REG_ALARM2_MINUTES        0x17
#define RTC9_REG_ALARM2_SECONDS        0x18
#define RTC9_FLAG_WATCHDOG_ENABLE          0x80
#define RTC9_FLAG_WATCHDOG_DISABLE         0x00
#define RTC9_FLAG_ALARM_1_ENABLE           0x40
#define RTC9_FLAG_ALARM_1_DISABLE          0x00
#define RTC9_FLAG_ALARM_2_ENABLE           0x20
#define RTC9_FLAG_ALARM_2_DISABLE          0x00
#define RTC9_FLAG_BATTERY_LOW_ENABLE       0x10
#define RTC9_FLAG_BATTERY_LOW_DISABLE      0x00
#define RTC9_FLAG_TIMER_ENABLE             0x08
#define RTC9_FLAG_TIMER_DISABLE            0x00
#define RTC9_FLAG_OSCILATOR_FAIL_ENABLE    0x04
#define RTC9_FLAG_OSCILATOR_FAIL_DISABLE   0x00
#define RTC9_TIMER_CONTROL_ENABLE                       0x80
#define RTC9_TIMER_CONTROL_DISABLE                      0x00
#define RTC9_TIMER_CONTROL_NORMAL_INT                   0x00
#define RTC9_TIMER_CONTROL_FREE_RUNNING_INT             0x40
#define RTC9_TIMER_CONTROL_INT_OUT_ASSERT               0x20
#define RTC9_TIMER_CONTROL_INT_OUT_DE_ASSERT            0x00
#define RTC9_TIMER_CONTROL_TIMER_SOURCE_FREQ_244p1_US   0x00
#define RTC9_TIMER_CONTROL_TIMER_SOURCE_FREQ_15p6_MS    0x01
#define RTC9_TIMER_CONTROL_TIMER_SOURCE_FREQ_1_S        0x02
#define RTC9_TIMER_CONTROL_TIMER_SOURCE_FREQ_60_S       0x03
#define RTC9_ANALOG_CALIBRATION_OSCILATOR_FREQ_NORMAL   0x00
#define RTC9_ANALOG_CALIBRATION_OSCILATOR_FREQ_SLOW     0x27
#define RTC9_ANALOG_CALIBRATION_OSCILATOR_FREQ_FAST     0xC8
#define RTC9_DIGITAL_CALIBRATION_POSITIVE               0x20
#define RTC9_DIGITAL_CALIBRATION_NEGATIVE               0x00
#define RTC9_DIGITAL_CALIBRATION_FREQ_TEST_ENABLED      0x40
#define RTC9_DIGITAL_CALIBRATION_FREQ_TEST_DISABLED     0x00
#define RTC9_DIGITAL_CALIBRATION_VALUE_0                0x00
#define RTC9_DIGITAL_CALIBRATION_VALUE_1                0x01
#define RTC9_DIGITAL_CALIBRATION_VALUE_2                0x02
#define RTC9_DIGITAL_CALIBRATION_VALUE_3                0x03
#define RTC9_DIGITAL_CALIBRATION_VALUE_4                0x04
#define RTC9_DIGITAL_CALIBRATION_VALUE_5                0x05
#define RTC9_DIGITAL_CALIBRATION_VALUE_6                0x06
#define RTC9_DIGITAL_CALIBRATION_VALUE_7                0x07
#define RTC9_DIGITAL_CALIBRATION_VALUE_8                0x08
#define RTC9_DIGITAL_CALIBRATION_VALUE_9                0x09
#define RTC9_DIGITAL_CALIBRATION_VALUE_10               0x0A
#define RTC9_DIGITAL_CALIBRATION_VALUE_11               0x0B
#define RTC9_DIGITAL_CALIBRATION_VALUE_12               0x0C
#define RTC9_DIGITAL_CALIBRATION_VALUE_13               0x0D
#define RTC9_DIGITAL_CALIBRATION_VALUE_14               0x0E
#define RTC9_DIGITAL_CALIBRATION_VALUE_15               0x0F
#define RTC9_DIGITAL_CALIBRATION_VALUE_16               0x10
#define RTC9_DIGITAL_CALIBRATION_VALUE_17               0x11
#define RTC9_DIGITAL_CALIBRATION_VALUE_18               0x12
#define RTC9_DIGITAL_CALIBRATION_VALUE_19               0x13
#define RTC9_DIGITAL_CALIBRATION_VALUE_20               0x14
#define RTC9_DIGITAL_CALIBRATION_VALUE_21               0x15
#define RTC9_DIGITAL_CALIBRATION_VALUE_22               0x16
#define RTC9_DIGITAL_CALIBRATION_VALUE_23               0x17
#define RTC9_DIGITAL_CALIBRATION_VALUE_24               0x18
#define RTC9_DIGITAL_CALIBRATION_VALUE_25               0x19
#define RTC9_DIGITAL_CALIBRATION_VALUE_26               0x1A
#define RTC9_DIGITAL_CALIBRATION_VALUE_27               0x1B
#define RTC9_DIGITAL_CALIBRATION_VALUE_28               0x1C
#define RTC9_DIGITAL_CALIBRATION_VALUE_29               0x1D
#define RTC9_DIGITAL_CALIBRATION_VALUE_30               0x1E
#define RTC9_DIGITAL_CALIBRATION_VALUE_31               0x1F
#define RTC9_WATCHDOG_OSCILATOR_FAIL_ENABLED            0x80
#define RTC9_WATCHDOG_OSCILATOR_FAIL_DISABLED           0x00
#define RTC9_WATCHDOG_RESOLUTION_1_DIV_16_SEC           0x00
#define RTC9_WATCHDOG_RESOLUTION_1_DIV_4_SEC            0x01
#define RTC9_WATCHDOG_RESOLUTION_1_SEC                  0x02
#define RTC9_WATCHDOG_RESOLUTION_4_SEC                  0x03
#define RTC9_MONTH_JANUARY                              0x01
#define RTC9_MONTH_FEBRUARY                             0x02
#define RTC9_MONTH_MARCH                                0x03
#define RTC9_MONTH_APRIL                                0x04
#define RTC9_MONTH_MAY                                  0x05
#define RTC9_MONTH_JUNE                                 0x06
#define RTC9_MONTH_JULY                                 0x07
#define RTC9_MONTH_AUGUST                               0x08
#define RTC9_MONTH_SEPTEMBER                            0x09
#define RTC9_MONTH_OCTOBER                              0x0A
#define RTC9_MONTH_NOVEMBER                             0x0B
#define RTC9_MONTH_DECEMBER                             0x0C
#define RTC9_DAY_SUNDAY                                 0x01
#define RTC9_DAY_MONDAY                                 0x02
#define RTC9_DAY_TUESDAY                                0x03
#define RTC9_DAY_WEDNESDAY                              0x04
#define RTC9_DAY_THURSDAY                               0x05
#define RTC9_DAY_FRIDAY                                 0x06
#define RTC9_DAY_SATURDAY                               0x07
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    uint8_t day;
    uint8_t day_of_week; 
    uint8_t month; 
    uint8_t year;
 
} rtc9_set_data_t;
 
typedef struct 
{
    uint8_t hour; 
    uint8_t min;
    uint8_t sec; 
    uint8_t part_sec;
 
} rtc9_get_time_t;
 
typedef struct 
{
    uint8_t day;
    uint8_t day_of_week; 
    uint8_t month; 
    uint8_t year;
 
} rtc9_get_date_t;
 
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
    rtc9_set_data_t set_data;
    rtc9_get_time_t get_time;
    rtc9_get_date_t get_date;
 
} rtc9_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} rtc9_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rtc9_cfg_setup ( rtc9_cfg_t *cfg );
 
RTC9_RETVAL rtc9_init ( rtc9_t *ctx, rtc9_cfg_t *cfg );
 
void rtc9_generic_write ( rtc9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void rtc9_generic_read ( rtc9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void rtc9_wakeup ( rtc9_t *ctx );
 
void rtc9_software_reset( rtc9_t *ctx ) ;
 
void rtc9_hardware_reset ( rtc9_t *ctx );
 
void rtc9_set_time( rtc9_t *ctx, uint8_t hour, uint8_t min, uint8_t sec );
 
void rtc9_set_date ( rtc9_t *ctx, rtc9_set_data_t *set_data );
 
void rtc9_get_time( rtc9_t *ctx, rtc9_get_time_t *get_time );
 
void rtc9_get_date( rtc9_t *ctx, rtc9_get_date_t *get_data );
 
char *rtc9_current_month( uint8_t month );
 
char *rtc9_current_day_of_week( uint8_t day_of_week );
 
void rtc9_set_alarm_time( rtc9_t *ctx, uint8_t hour, uint8_t min, uint8_t sec );
 
void rtc9_set_alarm_date ( rtc9_t *ctx, uint8_t day, uint8_t month, uint8_t year );
 
void rtc9_read_flag_status ( rtc9_t *ctx, uint8_t *read_data );
 
#ifdef __cplusplus
}
#endif
#endif  // _RTC9_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END