rtc12.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 RTC12_H
#define RTC12_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 RTC12_REG_SECONDS                     0x00
#define RTC12_REG_MINUTES                     0x01
#define RTC12_REG_HOUR                        0x02
#define RTC12_REG_DAY                         0x03
#define RTC12_REG_DATE                        0x04
#define RTC12_REG_MONTH                       0x05
#define RTC12_REG_YEAR                        0x06
#define RTC12_REG_ALARM_0_SECONDS             0x07
#define RTC12_REG_ALARM_0_MINUTES             0x08
#define RTC12_REG_ALARM_0_HOUR                0x09
#define RTC12_REG_ALARM_0_DAY                 0x0A
#define RTC12_REG_ALARM_1_SECONDS             0x0B
#define RTC12_REG_ALARM_1_MINUTES             0x0C
#define RTC12_REG_ALARM_1_HOUR                0x0D
#define RTC12_REG_ALARM_1_DAY                 0x0E
#define RTC12_REG_CONTROL                     0x0F
#define RTC12_REG_STATUS                      0x10
#define RTC12_REG_TRICKLE_CHARGER             0x11
 
 // rtc12_reg
 
#define RTC12_SET_EOSC_ENABLE                 0x00
#define RTC12_SET_EOSC_DISABLE                0x01
#define RTC12_SET_DOSF_ENABLE                 0x00
#define RTC12_SET_DOSF_DISABL                 0x01
#define RTC12_SET_EGFIL_DISABLE               0x00
#define RTC12_SET_EGFIL_ENABLE                0x01
#define RTC12_SET_SQW_DISABLE                 0x00
#define RTC12_SET_SQW_ENABLE                  0x01
#define RTC12_SET_INTCN_A0IE                  0x00
#define RTC12_SET_INTCN_A0IE_A1IE             0x01
#define RTC12_SET_ALARM_1_DISABLE             0x00
#define RTC12_SET_ALARM_1_ENABLE              0x01
#define RTC12_SET_ALARM_0_DISABLE             0x00
#define RTC12_SET_ALARM_0_ENABLE              0x01
 
 
 // rtc12_set
 
#define RTC12_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.pf = MIKROBUS( mikrobus, MIKROBUS_AN );     \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc12_map
 // rtc12
 
typedef struct
{
    // Input pins
 
    digital_in_t  pf;         
    digital_in_t  int_pin;    
    // Modules
 
    spi_master_t  spi;        
    pin_name_t  chip_select;  
} rtc12_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  pf;          
    pin_name_t  int_pin;     
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} rtc12_cfg_t;
 
typedef struct 
{
    uint8_t hours; 
    uint8_t min;
    uint8_t sec; 
    
} rtc12_time_t;
 
typedef struct 
{
    uint8_t year;
    uint8_t month;
    uint8_t day;
    uint8_t day_of_week;
    
 
} rtc12_date_t;
 
typedef struct 
{
    uint8_t day;
    uint8_t hours; 
    uint8_t min;
    uint8_t sec;
    uint8_t alarm_rate;
    
} rtc12_alarm_t;
 
typedef struct 
{
    uint8_t eosc;
    uint8_t dosf; 
    uint8_t egfil;
    uint8_t sqw;
    uint8_t intcn;
    uint8_t a1ie;
    uint8_t a0ie;
    
} rtc12_control_t;
 
 
typedef enum
{
   RTC12_OK = 0,
   RTC12_ERROR = -1
 
} rtc12_return_value_t;
 
void rtc12_cfg_setup ( rtc12_cfg_t *cfg );
 
err_t rtc12_init ( rtc12_t *ctx, rtc12_cfg_t *cfg );
 
err_t rtc12_default_cfg ( rtc12_t *ctx );
 
err_t rtc12_generic_write ( rtc12_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t rtc12_generic_read ( rtc12_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t rtc12_set_ctrl_reg ( rtc12_t *ctx, rtc12_control_t rtc_ctrl );
 
err_t rtc12_get_ctrl_reg ( rtc12_t *ctx, rtc12_control_t *rtc_ctrl );
 
err_t rtc12_get_time ( rtc12_t *ctx, rtc12_time_t *rtc_time );
 
err_t rtc12_set_time ( rtc12_t *ctx, rtc12_time_t rtc_time );
 
err_t rtc12_get_date ( rtc12_t *ctx, rtc12_date_t *rtc_date );
 
err_t rtc12_set_date ( rtc12_t *ctx, rtc12_date_t rtc_date );
 
err_t rtc12_get_alarm_0 ( rtc12_t *ctx, rtc12_alarm_t *rtc_alarm );
 
err_t rtc12_set_alarm_0 ( rtc12_t *ctx, rtc12_alarm_t rtc_alarm );
 
err_t rtc12_get_alarm_1 ( rtc12_t *ctx, rtc12_alarm_t *rtc_alarm );
 
err_t rtc12_set_alarm_1 ( rtc12_t *ctx, rtc12_alarm_t rtc_alarm );
 
uint8_t rtc12_check_int ( rtc12_t *ctx );
 
uint8_t rtc12_check_power_fail ( rtc12_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // RTC12_H
 
 // rtc12
 
// ------------------------------------------------------------------------ END