rtc11.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 RTC11_H
#define RTC11_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_spi_master.h"
 
#define RTC11_RD_BIT_MASK     0x7F
#define RTC11_WR_BIT_MASK     0x80
 
#define RTC11_REG_HDT         0x00
#define RTC11_REG_SEC         0x01
#define RTC11_REG_MIN         0x02
#define RTC11_REG_HRS         0x03
#define RTC11_REG_DAT         0x04
#define RTC11_REG_MON         0x05
#define RTC11_REG_YRS         0x06
#define RTC11_REG_WKD         0x07
#define RTC11_REG_ALA_HDT     0x08
#define RTC11_REG_ALA_SEC     0x09
#define RTC11_REG_ALA_MIN     0x0A
#define RTC11_REG_ALA_HRS     0x0B
#define RTC11_REG_ALA_DAT     0x0C
#define RTC11_REG_ALA_MON     0x0D
#define RTC11_REG_ALA_WKD     0x0E
#define RTC11_REG_STAT        0x0F
#define RTC11_REG_CTL1        0x10
#define RTC11_REG_CTL2        0x11
#define RTC11_REG_INT_MSK     0x12
#define RTC11_REG_SQW         0x13
#define RTC11_REG_CAL_XT      0x14
#define RTC11_REG_CAL_RC_HI   0x15
#define RTC11_REG_CAL_RC_LOW  0x16
#define RTC11_REG_INT_POL     0x17
#define RTC11_REG_TMR_CTL     0x18
#define RTC11_REG_TMR         0x19
#define RTC11_REG_TMR_INIT    0x1A
#define RTC11_REG_WDT         0x1B
#define RTC11_REG_OSC_CTL     0x1C
#define RTC11_REG_OSC_STAT    0x1D
#define RTC11_REG_CFG_KEY     0x1F
#define RTC11_REG_TRCK        0x20
#define RTC11_REG_BREF_CTL    0x21
#define RTC11_REG_BAT_MODE    0x27
#define RTC11_REG_ID_0        0x28
#define RTC11_REG_ID_1        0x29
#define RTC11_REG_ID_2        0x2A
#define RTC11_REG_ID_3        0x2B
#define RTC11_REG_ID_4        0x2C
#define RTC11_REG_ID_5        0x2D
#define RTC11_REG_ID_6        0x2E
#define RTC11_REG_ASTAT       0x2F
#define RTC11_REG_OCTRL       0x30
#define RTC11_REG_EXT_ADR     0x3F
#define RTC11_REG_RAM         0x40
 
 // rtc11_reg
 
#define RTC11_CTL1_STOP       0x80
#define RTC11_CTL1_12_HRS     0x40
#define RTC11_CTL1_OUTB       0x20
#define RTC11_CTL1_OUT        0x10
#define RTC11_CTL1_ARST       0x04
#define RTC11_CTL1_WRTC       0x01
 
#define RTC11_ACS_OSC_CTL     0xA1
#define RTC11_SW_RST          0x3C
#define RTC11_ACS_AN_CTL_REG  0x9D
 
#define RTC11_CEB             0x80
#define RTC11_BLIE            0x10
#define RTC11_TIE             0x08
#define RTC11_AIE             0x04
#define RTC11_EX2E            0x02
#define RTC11_EX1E            0x01
 
#define RTC11_PROP_DIS        0x00
#define RTC11_PROP_EN         0x01
 
 // rtc11_set
 
#define RTC11_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.wdi = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.exi = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.it2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.it1 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc11_map
 // rtc11
 
typedef struct
{
    // Output pins
    digital_out_t  wdi;       
    digital_out_t  exi;     
    // Input pins
    digital_in_t  it2;       
    digital_in_t  it1;       
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
} rtc11_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    // Additional gpio pins
    pin_name_t   wdi;         
    pin_name_t  exi;        
    pin_name_t  it2;        
    pin_name_t  it1;        
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} rtc11_cfg_t;
 
typedef struct 
{
    uint8_t hours; 
    uint8_t min;
    uint8_t sec; 
} rtc11_time_t;
 
typedef struct 
{
    uint8_t year;
    uint8_t month;
    uint8_t day;
    uint8_t day_of_week;
} rtc11_date_t;
 
typedef enum
{
   RTC11_OK = 0,
   RTC11_ERROR = -1
 
} rtc11_return_value_t;
 
void rtc11_cfg_setup ( rtc11_cfg_t *cfg );
 
err_t rtc11_init ( rtc11_t *ctx, rtc11_cfg_t *cfg );
 
void rtc11_generic_write ( rtc11_t *ctx, uint8_t reg, uint8_t *wr_data, uint16_t n_len );
 
void rtc11_generic_read ( rtc11_t *ctx, uint8_t reg, uint8_t *rd_data, uint16_t n_len );
 
uint8_t rtc11_check_irq_1 ( rtc11_t *ctx );
 
uint8_t rtc11_check_irq_2 ( rtc11_t *ctx );
 
void rtc11_wdi ( rtc11_t *ctx, uint8_t state );
 
void rtc11_ext_int ( rtc11_t *ctx, uint8_t state );
 
void rtc11_set_time_hundredths ( rtc11_t *ctx, uint8_t hundredths );
 
void rtc11_set_time_seconds ( rtc11_t *ctx, uint8_t seconds );
 
void rtc11_set_time_minutes ( rtc11_t *ctx, uint8_t minutes );
 
void rtc11_set_time_hours ( rtc11_t *ctx, uint8_t hours );
 
uint8_t rtc11_get_time_hundredths ( rtc11_t *ctx );
 
uint8_t rtc11_get_time_seconds ( rtc11_t *ctx );
 
uint8_t rtc11_get_time_minutes ( rtc11_t *ctx );
 
uint8_t rtc11_get_time_hours ( rtc11_t *ctx );
 
uint8_t rtc11_get_date_day ( rtc11_t *ctx );
 
void rtc11_set_date_day ( rtc11_t *ctx, uint8_t date_day );
 
uint8_t rtc11_get_date_month ( rtc11_t *ctx );
 
void rtc11_set_date_month ( rtc11_t *ctx, uint8_t date_mth );
 
uint8_t rtc11_get_date_year ( rtc11_t *ctx );
 
void rtc11_set_date_year ( rtc11_t *ctx, uint16_t date_yrs );
 
uint8_t rtc11_get_century_flag ( rtc11_t *ctx );
 
uint8_t rtc11_get_day_of_the_week ( rtc11_t *ctx );
 
void rtc11_set_day_of_the_week ( rtc11_t *ctx, uint8_t w_day );
 
void rtc11_set_ala_time_hundredths ( rtc11_t *ctx, uint8_t hundredths );
 
void rtc11_set_ala_time_seconds ( rtc11_t *ctx, uint8_t seconds );
 
void rtc11_set_ala_time_minutes ( rtc11_t *ctx, uint8_t minutes );
 
void rtc11_set_ala_time_hours ( rtc11_t *ctx, uint8_t hours );
 
uint8_t rtc11_get_ala_time_hundredths ( rtc11_t *ctx );
 
uint8_t rtc11_get_ala_time_seconds ( rtc11_t *ctx );
 
uint8_t rtc11_get_ala_time_minutes ( rtc11_t *ctx );
 
uint8_t rtc11_get_ala_time_hours ( rtc11_t *ctx );
 
uint8_t rtc11_get_ala_date_day ( rtc11_t *ctx );
 
void rtc11_set_ala_date_day ( rtc11_t *ctx, uint8_t date_day );
 
uint8_t rtc11_get_ala_date_month ( rtc11_t *ctx );
 
void rtc11_set_ala_date_month ( rtc11_t *ctx, uint8_t date_mth );
 
uint8_t rtc11_get_ala_day_of_the_week ( rtc11_t *ctx );
 
void rtc11_set_ala_day_of_the_week ( rtc11_t *ctx, uint8_t w_day );
 
void rtc11_soft_rst ( rtc11_t *ctx );
 
err_t rtc11_set_time ( rtc11_t *ctx, rtc11_time_t rtc_time );
 
void rtc11_get_time ( rtc11_t *ctx, rtc11_time_t *rtc_time );
 
err_t rtc11_set_date ( rtc11_t *ctx, rtc11_date_t rtc_date );
 
void rtc11_get_date ( rtc11_t *ctx, rtc11_date_t *rtc_date );
 
void rtc11_stp_sys_slk ( rtc11_t *ctx, uint8_t state );
 
void rtc11_auto_rst ( rtc11_t *ctx, uint8_t state );
 
void rtc11_write_rtc ( rtc11_t *ctx, uint8_t state );
 
void rtc11_cen_en ( rtc11_t *ctx, uint8_t state );
 
void rtc11_bat_low_int_en ( rtc11_t *ctx, uint8_t state );
 
void rtc11_timer_int_en ( rtc11_t *ctx, uint8_t state );
 
void rtc11_alarm_int_en ( rtc11_t *ctx, uint8_t state );
 
void rtc11_xt2_int_en ( rtc11_t *ctx, uint8_t state );
 
void rtc11_xt1_int_en ( rtc11_t *ctx, uint8_t state );
 
void rtc11_bat_mode_en ( rtc11_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif // RTC11_H
 
 // rtc11
 
// ------------------------------------------------------------------------ END