rtc13.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 RTC13_H
#define RTC13_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"
#include "spi_specifics.h"
 
#define RTC13_REG_CTRL1_ADDR                           0x00
#define RTC13_REG_CTRL2_ADDR                           0x01
#define RTC13_REG_TIME_SECONDS                         0x02
#define RTC13_REG_TIME_MINUTES                         0x03
#define RTC13_REG_TIME_HOUR                            0x04
#define RTC13_REG_DATE_DAY                             0x05
#define RTC13_REG_DATE_WEEKDAYS                        0x06
#define RTC13_REG_DATE_MONTHS                          0x07
#define RTC13_REG_DATE_YEARS                           0x08
#define RTC13_REG_ALARM_MINUTE                         0x09
#define RTC13_REG_ALARM_HOUR                           0x0A
#define RTC13_REG_ALARM_DAY                            0x0B
#define RTC13_REG_ALARM_WEEKDAY                        0x0C
#define RTC13_REG_OFFSET_ADDR                          0x0D
#define RTC13_REG_TIMER_CLKOUT_ADDR                    0x0E
#define RTC13_REG_COUNTDOWN_TIMER_ADDR                 0x0F
 
 // rtc13_reg
 
#define RTC13_SOFT_RESET                               0x58
#define RTC13_BLOCK_CLKOUT_DISABLE                     0x00
#define RTC13_BLOCK_CLKOUT_ENABLE                      0x01
 
#define RTC13_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define RTC13_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // rtc13_set
 
#define RTC13_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.cle = MIKROBUS( mikrobus, MIKROBUS_RST );   \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc13_map
 // rtc13
 
typedef struct 
{
    uint8_t hours; 
    uint8_t min;
    uint8_t sec; 
    
} rtc13_time_t;
 
typedef struct 
{
    uint8_t year;
    uint8_t month;
    uint8_t day;
    uint8_t weekday;
 
} rtc13_date_t;
 
typedef struct 
{
    uint8_t min;
    uint8_t hours;
    uint8_t day;
    uint8_t weekday;
    
} rtc13_alarm_t;
 
typedef struct
{
    // Output pins
    digital_out_t  cle;         
    // Input pins
    digital_in_t  int_pin;      
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} rtc13_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  cle;           
    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;      
} rtc13_cfg_t;
 
typedef enum
{
   RTC13_OK = 0,
   RTC13_ERROR = -1
 
} rtc13_return_value_t;
 
void rtc13_cfg_setup ( rtc13_cfg_t *cfg );
 
err_t rtc13_init ( rtc13_t *ctx, rtc13_cfg_t *cfg );
 
err_t rtc13_default_cfg ( rtc13_t *ctx );
 
uint8_t rtc13_get_interrupt ( rtc13_t *ctx );
 
err_t rtc13_block_clkout ( rtc13_t *ctx, uint8_t en_clkout );
 
err_t rtc13_generic_write ( rtc13_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t rtc13_generic_read ( rtc13_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t rtc13_soft_reset ( rtc13_t *ctx );
 
err_t rtc13_get_time ( rtc13_t *ctx, rtc13_time_t *rtc_time );
 
err_t rtc13_set_time ( rtc13_t *ctx, rtc13_time_t rtc_time );
 
err_t rtc13_get_date ( rtc13_t *ctx, rtc13_date_t *rtc_date );
 
err_t rtc13_set_date ( rtc13_t *ctx, rtc13_date_t rtc_date );
 
err_t rtc13_get_alarm ( rtc13_t *ctx, rtc13_alarm_t *rtc_alarm );
 
err_t rtc13_set_alarm ( rtc13_t *ctx, rtc13_alarm_t rtc_alarm );
 
#ifdef __cplusplus
}
#endif
#endif // RTC13_H
 
 // rtc13
 
// ------------------------------------------------------------------------ END