rtc14.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 RTC14_H
#define RTC14_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 RTC14_REG_SC                                         0x00
#define RTC14_REG_MN                                         0x01
#define RTC14_REG_HR                                         0x02
#define RTC14_REG_DT                                         0x03
#define RTC14_REG_MO                                         0x04
#define RTC14_REG_YR                                         0x05
#define RTC14_REG_DW                                         0x06
#define RTC14_REG_SR                                         0x07
#define RTC14_REG_INT                                        0x08
#define RTC14_REG_ATR                                        0x0A
#define RTC14_REG_DTR                                        0x0B
#define RTC14_REG_SCA                                        0x0C
#define RTC14_REG_MNA                                        0x0D
#define RTC14_REG_HRA                                        0x0E
#define RTC14_REG_DTA                                        0x0F
#define RTC14_REG_MOA                                        0x10
#define RTC14_REG_DWA                                        0x11
#define RTC14_REG_USR1                                       0x12
#define RTC14_REG_USR2                                       0x13
#define RTC14_REG_SCT                                        0x14
#define RTC14_REG_MNT                                        0x15
#define RTC14_REG_HRT                                        0x16
#define RTC14_REG_DTT                                        0x17
#define RTC14_REG_MOT                                        0x18
#define RTC14_REG_YRT                                        0x19
 
 // rtc14_reg
 
#define RTC14_SET_HOURS_FORMAT_12                            0x00
#define RTC14_SET_HOURS_FORMAT_24                            0x80
#define RTC14_SET_HOURS_FORMAT_12_AM                         0x00
#define RTC14_SET_HOURS_FORMAT_12_PM                         0x20
#define RTC14_SET_ALARM_ENABLE                               0x80
#define RTC14_SET_INT_ENABLE                                 0x40
#define RTC14_SET_SOFT_RESET                                 0x80
#define RTC14_SET_ENABLE_WRTC                                0x10
 
#define RTC14_DW_SUNDAY                                      0x00
#define RTC14_DW_MONDAY                                      0x01
#define RTC14_DW_TUESDAY                                     0x02
#define RTC14_DW_WEDNESDAY                                   0x03
#define RTC14_DW_THURSDAY                                    0x04
#define RTC14_DW_FRIDAY                                      0x05
#define RTC14_DW_SATURDAY                                    0x06
 
#define RTC14_SET_DEV_ADDR                                   0x6F
 
 // rtc14_set
 
#define RTC14_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.fo = MIKROBUS( mikrobus, MIKROBUS_AN );   \
    cfg.ein = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc14_map
 // rtc14
 
typedef struct
{
    // Output pins
    digital_out_t  ein;      
    // Input pins
    digital_in_t  fo;        
    digital_in_t  int_pin;   
    // Modules
    i2c_master_t i2c;        
    // I2C slave address
    uint8_t slave_address;   
} rtc14_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  fo;         
    pin_name_t  ein;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} rtc14_cfg_t;
 
typedef struct 
{
    uint8_t hours_format;
    uint8_t am_pm;
    uint8_t hours; 
    uint8_t min;
    uint8_t sec; 
    
} rtc14_time_t;
 
typedef struct 
{
    uint8_t year;
    uint8_t month;
    uint8_t day;
    uint8_t day_of_week;
    
 
} rtc14_date_t;
 
typedef struct 
{
    uint8_t sec;
    uint8_t min;
    uint8_t hours;
    uint8_t day;
    uint8_t month;
    uint8_t day_of_week;
    
} rtc14_alarm_t;
 
typedef struct 
{
    uint8_t sec;
    uint8_t min;
    uint8_t hours;
    uint8_t day;
    uint8_t month;
    uint8_t year;
    
} rtc14_time_stamp_t;
 
typedef enum
{
   RTC14_OK = 0,
   RTC14_ERROR = -1
 
} rtc14_return_value_t;
 
void rtc14_cfg_setup ( rtc14_cfg_t *cfg );
 
err_t rtc14_init ( rtc14_t *ctx, rtc14_cfg_t *cfg );
 
err_t rtc14_default_cfg ( rtc14_t *ctx );
 
err_t rtc14_generic_write ( rtc14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t rtc14_generic_read ( rtc14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t rtc14_write_sram ( rtc14_t *ctx, uint16_t sram_data_in );
 
err_t rtc14_read_sram ( rtc14_t *ctx, uint16_t *sram_data_out );
 
uint8_t rtc14_get_interrupt ( rtc14_t *ctx );
 
uint8_t rtc14_get_fout ( rtc14_t *ctx );
 
err_t rtc14_enable_rtc ( rtc14_t *ctx );
 
err_t rtc14_soft_reset ( rtc14_t *ctx );
 
err_t rtc14_get_time ( rtc14_t *ctx, rtc14_time_t *rtc_time );
 
err_t rtc14_set_time ( rtc14_t *ctx, rtc14_time_t rtc_time );
 
err_t rtc14_get_date ( rtc14_t *ctx, rtc14_date_t *rtc_date );
 
err_t rtc14_set_date ( rtc14_t *ctx, rtc14_date_t rtc_date );
 
err_t rtc14_get_alarm ( rtc14_t *ctx, rtc14_alarm_t *rtc_alarm );
 
err_t rtc14_set_alarm ( rtc14_t *ctx, rtc14_alarm_t rtc_alarm );
 
void rtc14_trigger_time_stamp ( rtc14_t *ctx );
 
err_t rtc14_get_time_stamp ( rtc14_t *ctx, rtc14_time_stamp_t *rtc_time_stamp );
 
#ifdef __cplusplus
}
#endif
#endif // RTC14_H
 
 // rtc14
 
// ------------------------------------------------------------------------ END