rtc17.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 RTC17_H
#define RTC17_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 RTC17_REG_SECOND_COUNTER            0x00
#define RTC17_REG_MINUTE_COUNTER            0x01
#define RTC17_REG_HOUR_COUNTER              0x02
#define RTC17_REG_DAY_OF_WEEK_COUNTER       0x03
#define RTC17_REG_DAY_COUNTER               0x04
#define RTC17_REG_MONTH_COUNTER             0x05
#define RTC17_REG_YEAR_COUNTER              0x06
#define RTC17_REG_OSC_ADJ                   0x07
#define RTC17_REG_ALARM_W_MINUTE            0x08
#define RTC17_REG_ALARM_W_HOUR              0x09
#define RTC17_REG_ALARM_W_DAY_OF_WEEK       0x0A
#define RTC17_REG_ALARM_D_MINUTE            0x0B
#define RTC17_REG_ALARM_D_HOUR              0x0C
#define RTC17_REG_CONTROL1                  0x0E
#define RTC17_REG_CONTROL2                  0x0F
 
 // rtc17_reg
 
#define RTC17_CONTROL1_ALARM_W_DISABLE      0x00
#define RTC17_CONTROL1_ALARM_W_ENABLE       0x80
#define RTC17_CONTROL1_ALARM_D_DISABLE      0x00
#define RTC17_CONTROL1_ALARM_D_ENABLE       0x40
#define RTC17_CONTROL1_12HOUR_TIME          0x00
#define RTC17_CONTROL1_24HOUR_TIME          0x20
#define RTC17_CONTROL1_CLOCK1_ENABLE        0x00
#define RTC17_CONTROL1_CLOCK1_DISABLE       0x10
#define RTC17_CONTROL1_TEST_NORMAL          0x00
#define RTC17_CONTROL1_TEST_TEST            0x08
#define RTC17_CONTROL1_CT_OFF               0x00
#define RTC17_CONTROL1_CT_FIXED_L           0x01
#define RTC17_CONTROL1_CT_PULSE_2HZ         0x02
#define RTC17_CONTROL1_CT_PULSE_1HZ         0x03
#define RTC17_CONTROL1_CT_EVERY_SECOND      0x04
#define RTC17_CONTROL1_CT_EVERY_MINUTE      0x05
#define RTC17_CONTROL1_CT_EVERY_HOUR        0x06
#define RTC17_CONTROL1_CT_EVERY_MONTH       0x07
 
#define RTC17_CONTROL2_VDSL_2p1V            0x00
#define RTC17_CONTROL2_VDSL_1p6V            0x80
#define RTC17_CONTROL2_VDET_ABOVE           0x00
#define RTC17_CONTROL2_VDET_BELOW           0x40
#define RTC17_CONTROL2_SCRATCH_BIT          0x20
#define RTC17_CONTROL2_XSTP_NORMAL          0x00
#define RTC17_CONTROL2_XSTP_HALT            0x10
#define RTC17_CONTROL2_CLOCK2_ENABLE        0x00
#define RTC17_CONTROL2_CLOCK2_DISABLE       0x08
#define RTC17_CONTROL2_CLEAR_INTERRUPT      0x04
#define RTC17_CONTROL2_CLEAR_ALARM_W        0x02
#define RTC17_CONTROL2_CLEAR_ALARM_D        0x01
 
#define RTC17_MONDAY                        0x00
#define RTC17_TUESDAY                       0x01
#define RTC17_WEDNESDAY                     0x02
#define RTC17_THURSDAY                      0x03
#define RTC17_FRIDAY                        0x04
#define RTC17_SATURDAY                      0x05
#define RTC17_SUNDAY                        0x06
 
#define RTC17_SET_DEVICE_ADDRESS            0x32
 
 // rtc17_set
 
#define RTC17_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc17_map
 // rtc17
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} rtc17_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} rtc17_cfg_t;
 
typedef struct
{
    uint8_t second;
    uint8_t minute;
    uint8_t hour;
 
} rtc17_time_t;
 
typedef struct
{
    uint8_t day_of_week;
    uint8_t day;
    uint8_t month;
    uint8_t year;
 
} rtc17_date_t;
 
typedef enum
{
    RTC17_OK = 0,
    RTC17_ERROR = -1
 
} rtc17_return_value_t;
 
void rtc17_cfg_setup ( rtc17_cfg_t *cfg );
 
err_t rtc17_init ( rtc17_t *ctx, rtc17_cfg_t *cfg );
 
err_t rtc17_default_cfg ( rtc17_t *ctx );
 
err_t rtc17_write_register ( rtc17_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t rtc17_write_multiple_registers ( rtc17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t rtc17_read_register ( rtc17_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t rtc17_read_multiple_registers ( rtc17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
uint8_t rtc17_get_int_pin ( rtc17_t *ctx );
 
err_t rtc17_clear_interrupts ( rtc17_t *ctx );
 
err_t rtc17_set_time ( rtc17_t *ctx, rtc17_time_t *time );
 
err_t rtc17_read_time ( rtc17_t *ctx, rtc17_time_t *time );
 
err_t rtc17_set_date ( rtc17_t *ctx, rtc17_date_t *date );
 
err_t rtc17_read_date ( rtc17_t *ctx, rtc17_date_t *date );
 
#ifdef __cplusplus
}
#endif
#endif // RTC17_H
 
 // rtc17
 
// ------------------------------------------------------------------------ END