rtc5.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 RTC5_H
#define RTC5_H
 
#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"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define RTC5_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.mfp = MIKROBUS( mikrobus, MIKROBUS_INT );
#define RTC5_RETVAL  uint8_t
 
#define RTC5_OK           0x00
#define RTC5_INIT_ERROR   0xFF
#define RTC5_REG_TIME_HUN_OF_SEC                                0x00
#define RTC5_REG_TIME_SEC                                       0x01
#define RTC5_REG_TIME_MIN                                       0x02
#define RTC5_REG_TIME_HOUR                                      0x03
#define RTC5_REG_TIME_DAY_OF_THE_WEEK                           0x04
#define RTC5_REG_TIME_DATE_DAY                                  0x05
#define RTC5_REG_TIME_DATE_MONTH                                0x06
#define RTC5_REG_TIME_DATE_YEAR                                 0x07
#define RTC5_REG_CONFIG                                         0x08
#define RTC5_REG_CALIBRATION                                    0x09
#define RTC5_REG_ALARM_0_SEC                                    0x0C
#define RTC5_REG_ALARM_0_MIN                                    0x0D
#define RTC5_REG_ALARM_0_HOUR                                   0x0E
#define RTC5_REG_ALARM_0_DATE_DATE                              0x0F
#define RTC5_REG_ALARM_0_DATE_DAY                               0x10
#define RTC5_REG_ALARM_0_MONTH                                  0x11
#define RTC5_REG_ALARM_1_HUN_OF_SEC                             0x12
#define RTC5_REG_ALARM_1_SEC                                    0x13
#define RTC5_REG_ALARM_1_MIN                                    0x14
#define RTC5_REG_ALARM_1_HOUR                                   0x15
#define RTC5_REG_ALARM_1_DATE_DATE                              0x16
#define RTC5_REG_ALARM_1_DATE_DAY                               0x17
#define RTC5_ALARM_0_VALUE                                      0x00
#define RTC5_ALARM_1_VALUE                                      0x01
#define RTC5_SPI_WRITE                                          0x12
#define RTC5_SPI_READ                                           0x13
#define RTC5_OSC_DISABLE                                        0x00
#define RTC5_OSC_ENABLE                                         0x01
#define RTC5_COUNTING_DISABLE                                   0x7F
#define RTC5_COUNTING_ENABLE                                    0x80
#define RTC5_CLR_CMD                                           0x54
#define RTC5_DAY_OF_THE_WEEK_MONDAY                             1
#define RTC5_DAY_OF_THE_WEEK_TUESDAY                            2
#define RTC5_DAY_OF_THE_WEEK_WEDNESDAY                          3
#define RTC5_DAY_OF_THE_WEEK_THURSDAY                           4
#define RTC5_DAY_OF_THE_WEEK_FRIDAY                             5
#define RTC5_DAY_OF_THE_WEEK_SATURDAY                           6
#define RTC5_DAY_OF_THE_WEEK_SUNDAY                             7
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_out_t cs;
 
    // Input pins 
 
    digital_in_t mfp;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} rtc5_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 mfp;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} rtc5_cfg_t;
 
typedef struct
{
    // Time 
 
    uint8_t hun_of_sec;
    uint8_t sec;
    uint8_t min;
    uint8_t hours;
 
    // Date
 
    uint8_t day;
    uint8_t month;
    uint8_t year;
    uint8_t w_day;
 
} rtc5_timedate_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void rtc5_cfg_setup ( rtc5_cfg_t *cfg );
 
RTC5_RETVAL rtc5_init ( rtc5_t *ctx, rtc5_cfg_t *cfg );
 
void rtc5_default_cfg ( rtc5_t *ctx );
 
void rtc5_generic_transfer 
( 
    rtc5_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);
 
void rtc5_generic_write ( rtc5_t *ctx, uint8_t reg, uint8_t tx_data );
 
uint8_t rtc5_generic_read ( rtc5_t *ctx, uint8_t reg );
 
void rtc5_set_counting ( rtc5_t *ctx, uint8_t en_osc );
 
void rtc5_clear ( rtc5_t *ctx );
 
void rtc5_set_time_hun_of_sec ( rtc5_t *ctx, uint8_t hun_sec );
 
uint8_t rtc5_get_time_hun_of_sec ( rtc5_t *ctx );
 
void rtc5_set_time_sec ( rtc5_t *ctx, uint8_t seconds );
 
uint8_t rtc5_get_time_sec ( rtc5_t *ctx );
 
void rtc5_set_time_min ( rtc5_t *ctx, uint8_t minutes );
 
uint8_t rtc5_get_time_min ( rtc5_t *ctx );
 
void rtc5_set_time_hours ( rtc5_t *ctx, uint8_t hours );
 
uint8_t rtc5_get_time_hours ( rtc5_t *ctx );
 
void rtc5_set_day_of_the_week ( rtc5_t *ctx, uint8_t w_day );
 
uint8_t rtc5_get_day_of_the_week ( rtc5_t *ctx );
 
void rtc5_set_date_day ( rtc5_t *ctx, uint8_t date_day );
 
uint8_t rtc5_get_date_day ( rtc5_t *ctx );
 
void rtc5_set_date_month ( rtc5_t *ctx, uint8_t date_month );
 
uint8_t rtc5_get_date_month ( rtc5_t *ctx );
 
uint8_t rtc5_get_leap_year ( rtc5_t *ctx );
 
void rtc5_set_date_year ( rtc5_t *ctx, uint16_t date_year );
 
uint8_t rtc5_get_date_year ( rtc5_t *ctx );
 
void rtc5_set_time ( rtc5_t *ctx, uint8_t time_hours, uint8_t time_min, uint8_t time_sec );
 
void rtc5_set_date ( rtc5_t *ctx, uint8_t date_day, uint8_t date_month, uint16_t date_year );
 
void rtc5_get_time_and_date ( rtc5_t *ctx, rtc5_timedate_t *timedate_data );
 
 
 
#ifdef __cplusplus
}
#endif
#endif  // _RTC5_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END