rtc20.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 RTC20_H
#define RTC20_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 RTC20_REG_HUNDREDTHS                    0x00
#define RTC20_REG_SECONDS                       0x01
#define RTC20_REG_MINUTES                       0x02
#define RTC20_REG_HOURS                         0x03
#define RTC20_REG_DATE                          0x04
#define RTC20_REG_MONTH                         0x05
#define RTC20_REG_YEAR                          0x06
#define RTC20_REG_DAY                           0x07
#define RTC20_REG_HUNDREDTHS_ALARM              0x08
#define RTC20_REG_SECONDS_ALARM                 0x09
#define RTC20_REG_MINUTES_ALARM                 0x0A
#define RTC20_REG_HOURS_ALARM                   0x0B
#define RTC20_REG_DATE_ALARM                    0x0C
#define RTC20_REG_MONTH_ALARM                   0x0D
#define RTC20_REG_WEEKDAYS_ALARM                0x0E
#define RTC20_REG_STATUS                        0x0F
#define RTC20_REG_CONTROL1                      0x10
#define RTC20_REG_CONTROL2                      0x11
#define RTC20_REG_OSC_CONTROL                   0x1C
#define RTC20_REG_OSC_STATUS                    0x1D
 
 // rtc20_reg
 
#define RTC20_SET_CTRL_STOP_DISABLE             0x00
#define RTC20_SET_CTRL_STOP_ENABLE              0x01
#define RTC20_SET_CTRL_HOURS_OP_MODE_24h        0x00
#define RTC20_SET_CTRL_HOURS_OP_MODE_12h        0x01
#define RTC20_SET_CTRL_OUTB_nIRQ2               0x00
#define RTC20_SET_CTRL_OUTB_LKO2                0x01
#define RTC20_SET_CTRL_OUT_nIRQ                 0x00
#define RTC20_SET_CTRL_OUT_SQWE                 0x01
#define RTC20_SET_CTRL_ARST_NO_CLR              0x00
#define RTC20_SET_CTRL_ARST_CLR                 0x01
#define RTC20_SET_CTRL_WRTC_DISABLE             0x00
#define RTC20_SET_CTRL_WRTC_ENABLE              0x01
#define RTC20_SET_CTRL_OUT2S_nIRQ_ENABLE        0x00
#define RTC20_SET_CTRL_OUT2S_SQW_ENABLE         0x01
#define RTC20_SET_CTRL_OUT2S_nAIRQ_ENABLE       0x03
#define RTC20_SET_CTRL_OUT2S_TIRQ_ENABLE        0x04
#define RTC20_SET_CTRL_OUT2S_nTIRQ_ENABLE       0x05
#define RTC20_SET_CTRL_OUT2S_OUTB_ENABLE        0x07
#define RTC20_SET_CTRL_OUT1S_nIRQ_ENABLE        0x00
#define RTC20_SET_CTRL_OUT1S_SQW_ENABLE         0x01
#define RTC20_SET_CTRL_OUT1S_SQW_nIRQ_ENABLE    0x02
#define RTC20_SET_CTRL_OUT1S_nAIRQ_ENABLE       0x03
 
#define RTC20_DW_SUNDAY                            0
#define RTC20_DW_MONDAY                            1
#define RTC20_DW_TUESDAY                           2
#define RTC20_DW_WEDNESDAY                         3
#define RTC20_DW_THURSDAY                          4
#define RTC20_DW_FRIDAY                            5
#define RTC20_DW_SATURDAY                          6
 
 
 
#define RTC20_DEVICE_ADDRESS                    0x69
 
 // rtc20_set
 
#define RTC20_MAP_MIKROBUS( cfg, mikrobus )       \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.ir2 = MIKROBUS( mikrobus, MIKROBUS_AN );  \
    cfg.wdi = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.ext = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.ir1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc20_map
 // rtc20
 
typedef struct
{
    // Output pins
    digital_out_t wdi;        
    digital_out_t ext;        
    // Input pins
    digital_in_t ir2;         
    digital_in_t ir1;         
    // Modules
    i2c_master_t i2c;         
    // I2C slave address
    uint8_t slave_address;    
} rtc20_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t ir2;            
    pin_name_t wdi;            
    pin_name_t ext;            
    pin_name_t ir1;            
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
} rtc20_cfg_t;
 
typedef struct
{
    uint8_t hundredths;
    uint8_t second;
    uint8_t minute;
    uint8_t hour;
 
} rtc20_time_t;
 
typedef struct
{
    uint8_t day_of_week;
    uint8_t day;
    uint8_t month;
    uint8_t year;
 
} rtc20_date_t;
 
typedef struct
{
    uint8_t stop;
    uint8_t hours_op_mode;
    uint8_t outb;
    uint8_t out;
    uint8_t arst;
    uint8_t wrtc;
    uint8_t out2s;
    uint8_t out1s;
 
} rtc20_ctrl_signals_t;
 
typedef enum
{
    RTC20_OK = 0,
    RTC20_ERROR = -1
 
} rtc20_return_value_t;
 
void rtc20_cfg_setup ( rtc20_cfg_t *cfg );
 
err_t rtc20_init ( rtc20_t *ctx, rtc20_cfg_t *cfg );
 
err_t rtc20_generic_write ( rtc20_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t rtc20_generic_read ( rtc20_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void rtc20_wdi_pin_state ( rtc20_t *ctx, uint8_t pin_state );
 
void rtc20_ext_pin_state ( rtc20_t *ctx, uint8_t pin_state );
 
err_t rtc20_set_time ( rtc20_t *ctx, rtc20_time_t rtc_time );
 
err_t rtc20_get_time ( rtc20_t *ctx, rtc20_time_t *rtc_time );
 
err_t rtc20_set_date ( rtc20_t *ctx, rtc20_date_t rtc_date );
 
err_t rtc20_get_date ( rtc20_t *ctx, rtc20_date_t *rtc_date );
 
err_t rtc20_set_alarm ( rtc20_t *ctx, rtc20_time_t rtc_alarm_time, rtc20_date_t rtc_alarm_date );
 
err_t rtc20_get_alarm ( rtc20_t *ctx, rtc20_time_t *rtc_alarm_time, rtc20_date_t *rtc_alarm_date );
 
err_t rtc20_get_status ( rtc20_t *ctx, uint8_t *status );
 
err_t rtc20_set_ctrl_signals ( rtc20_t *ctx, rtc20_ctrl_signals_t ctrl_signals );
 
err_t rtc20_get_ctrl_signals ( rtc20_t *ctx, rtc20_ctrl_signals_t *ctrl_signals );
 
uint8_t rtc20_get_ir1_pin ( rtc20_t *ctx );
 
uint8_t rtc20_get_ir2_pin ( rtc20_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // RTC20_H
 
 // rtc20
 
// ------------------------------------------------------------------------ END