rtc21.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 RTC21_H
#define RTC21_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 RTC21_REG_SECOND                    0x00
#define RTC21_REG_MINUTE                    0x01
#define RTC21_REG_HOUR                      0x02
#define RTC21_REG_DAY_OF_WEEK               0x03
#define RTC21_REG_DATE                      0x04
#define RTC21_REG_MONTH                     0x05
#define RTC21_REG_YEAR                      0x06
#define RTC21_REG_CONTROL                   0x07
#define RTC21_REG_RAM_BOTTOM                0x08
#define RTC21_REG_RAM_TOP                   0x3F
 
 // rtc21_reg
 
#define RTC21_MONDAY                        0x01
#define RTC21_TUESDAY                       0x02
#define RTC21_WEDNESDAY                     0x03
#define RTC21_THURSDAY                      0x04
#define RTC21_FRIDAY                        0x05
#define RTC21_SATURDAY                      0x06
#define RTC21_SUNDAY                        0x07
 
#define RTC21_DEVICE_ADDRESS                0x68
 
 // rtc21_set
 
#define RTC21_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.ft  = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // rtc21_map
 // rtc21
 
typedef struct
{
    // Input pins
    digital_in_t ft;            
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} rtc21_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t ft;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} rtc21_cfg_t;
 
typedef struct
{
    uint8_t second;
    uint8_t minute;
    uint8_t hour;
 
} rtc21_time_t;
 
typedef struct
{
    uint8_t day_of_week;
    uint8_t day;
    uint8_t month;
    uint8_t year;
 
} rtc21_date_t;
 
typedef enum
{
    RTC21_OK = 0,
    RTC21_ERROR = -1
 
} rtc21_return_value_t;
 
void rtc21_cfg_setup ( rtc21_cfg_t *cfg );
 
err_t rtc21_init ( rtc21_t *ctx, rtc21_cfg_t *cfg );
 
err_t rtc21_generic_write ( rtc21_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t rtc21_generic_read ( rtc21_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t rtc21_write_register ( rtc21_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t rtc21_read_register ( rtc21_t *ctx, uint8_t reg, uint8_t *data_out );
 
uint8_t rtc21_get_ft_pin ( rtc21_t *ctx );
 
err_t rtc21_set_time ( rtc21_t *ctx, rtc21_time_t *time );
 
err_t rtc21_read_time ( rtc21_t *ctx, rtc21_time_t *time );
 
err_t rtc21_set_date ( rtc21_t *ctx, rtc21_date_t *date );
 
err_t rtc21_read_date ( rtc21_t *ctx, rtc21_date_t *date );
 
#ifdef __cplusplus
}
#endif
#endif // RTC21_H
 
 // rtc21
 
// ------------------------------------------------------------------------ END