rtc6 2.0.0.0
rtc6.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
32// ----------------------------------------------------------------------------
33
34#ifndef RTC6_H
35#define RTC6_H
36
37#include "drv_digital_out.h"
38#include "drv_digital_in.h"
39#include "drv_i2c_master.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define RTC6_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
61#define RTC6_REG_SECONDS 0x00
62#define RTC6_REG_MINUTES 0x01
63#define RTC6_REG_HOURS 0x02
64#define RTC6_REG_DAY 0x03
65#define RTC6_REG_DATE 0x04
66#define RTC6_REG_MONTH 0x05
67#define RTC6_REG_YEARS 0x06
68#define RTC6_REG_CONTROL 0x07
69#define RTC6_REG_OSC_TRIM 0x08
70#define RTC6_REG_EEUNLOCK 0x09
71#define RTC6_REG_ALARM0_SECOND 0x0A
72#define RTC6_REG_ALARM0_MINUTE 0x0B
73#define RTC6_REG_ALARM0_HOUR 0x0C
74#define RTC6_REG_ALARM0_DAY 0x0D
75#define RTC6_REG_ALARM0_DATE 0x0E
76#define RTC6_REG_ALARM0_MONTH 0x0F
77#define RTC6_REG_ALARM1_SECOND 0x11
78#define RTC6_REG_ALARM1_MINUTE 0x12
79#define RTC6_REG_ALARM1_HOUR 0x13
80#define RTC6_REG_ALARM1_DAY 0x14
81#define RTC6_REG_ALARM1_DATE 0x15
82#define RTC6_REG_ALARM1_MONTH 0x16
83#define RTC6_REG_POWER_DOWN_MINUTE 0x18
84#define RTC6_REG_POWER_DOWN_HOUR 0x19
85#define RTC6_REG_POWER_DOWN_DATE 0x1A
86#define RTC6_REG_POWER_DOWN_MONTH 0x1B
87#define RTC6_REG_POWER_UP_MINUTE 0x1C
88#define RTC6_REG_POWER_UP_HOUR 0x1D
89#define RTC6_REG_POWER_UP_DATE 0x1E
90#define RTC6_REG_POWER_UP_MONTH 0x1F
97#define RTC6_OSCILLATOR_ENABLE 0x80
98#define RTC6_OSCILLATOR_DISABLE 0x00
105#define RTC6_FORMAT_12_HOURS 0x40
106#define RTC6_FORMAT_24_HOURS 0x00
113#define RTC6_SWO_1HZ 0x01
114#define RTC6_SWO_4_096KHZ 0x02
115#define RTC6_SWO_8_192KHZ 0x03
116#define RTC6_SWO_32_768KHZ 0x04
119/* Months in Year */
120#define RTC6_MONTH_JANUARY 0x00
121#define RTC6_MONTH_FEBRUARY 0x01
122#define RTC6_MONTH_MARCH 0x02
123#define RTC6_MONTH_APRIL 0x03
124#define RTC6_MONTH_MAY 0x04
125#define RTC6_MONTH_JUNE 0x05
126#define RTC6_MONTH_JULY 0x06
127#define RTC6_MONTH_AUGUST 0x07
128#define RTC6_MONTH_SEPTEMBER 0x08
129#define RTC6_MONTH_OCTOBER 0x09
130#define RTC6_MONTH_NOVEMBER 0x0A
131#define RTC6_MONTH_DECEMBER 0x0B
138#define RTC6_DAY_MONDAY 0x00
139#define RTC6_DAY_TUESDAY 0x01
140#define RTC6_DAY_WEDNESDAY 0x02
141#define RTC6_DAY_THURSDAY 0x03
142#define RTC6_DAY_FRIDAY 0x04
143#define RTC6_DAY_SATURDAY 0x05
144#define RTC6_DAY_SUNDAY 0x06
151#define RTC6_DEVICE_SLAVE_ADDR 0x6F
152#define RTC6_SRAM_SLAVE_ADDR 0xDE
153#define RTC6_EEPROM_SLAVE_ADDR 0x57
160#define RTC6_ALARM_0 0x00
161#define RTC6_ALARM_1 0x01
168#define RTC6_RETVAL uint8_t
169
170#define RTC6_OK 0x00
171#define RTC6_INIT_ERROR 0xFF
178#define SET_ERROR 0x02
179#define DEVICE_ERROR 0x01
180#define DEVICE_OK 0x00
187#define RTC6_TIMEDATE_BYTES 0x07
188#define RTC6_SECONDS_BYTE 0x00
189#define RTC6_MINUTES_BYTE 0x01
190#define RTC6_HOUR_BYTE 0x02
191#define RTC6_DAY_BYTE 0x03
192#define RTC6_DATE_BYTE 0x04
193#define RTC6_MONTH_BYTE 0x05
194#define RTC6_YEAR_BYTE 0x06
201#define RTC6_RAM_SIZE 64
202#define RTC6_RAM_START 0x20
203#define RTC6_RAM_END 0x5f
204#define RTC6_EEPROM_SIZE 1024
205#define RTC6_EEPROM_START 0
206#define RTC6_EEPROM_END 1024
207#define RTC6_EEPROM_PAGE_SIZE 8
208#define RTC6_EEPROM_STATUS 0xFF
211/* Seconds */
216#define TIME_SEC_IN_MIN 60
217#define TIME_SEC_IN_HOUR 3600
218#define TIME_SEC_IN_DAY 86400
219#define TIME_SEC_IN_MONTH 2629743
220#define TIME_SEC_IN_YEAR_365 31536000
221#define TIME_SEC_IN_LEAP_YEAR 31622400
222#define TIME_SEC_IN_YEAR_365_25 31557600 // End group macro
226// --------------------------------------------------------------- PUBLIC TYPES
235typedef struct
236{
237 uint8_t seconds;
238 uint8_t minutes;
239 uint8_t hours;
240 uint8_t weekdays;
241 uint8_t monthday;
242 uint8_t month;
243 uint16_t year;
244
246
250typedef struct
251{
252 // Input pins
253
254 digital_in_t int_pin;
255
256 // Modules
257
258 i2c_master_t i2c;
259
260 // ctx variable
261
263
264 int8_t time_zone;
265
266} rtc6_t;
267
271typedef struct
272{
273 // Communication gpio pins
274
275 pin_name_t scl;
276 pin_name_t sda;
277
278 // Additional gpio pins
279
280 pin_name_t int_pin;
281
282 // static variable
283
284 uint32_t i2c_speed;
285 uint8_t i2c_address;
286
287 // Time config value
288
290
291} rtc6_cfg_t;
292 // End types group
294// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
295
301#ifdef __cplusplus
302extern "C"{
303#endif
304
314
324
332void rtc6_default_cfg ( rtc6_t *ctx, int8_t time_zone, rtc6_time_t *utc_time, rtc6_time_t *alarm_time );
333
344void rtc6_generic_write ( rtc6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
345
356void rtc6_generic_read ( rtc6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
357
358uint8_t rtc6_init_fun ( rtc6_t *ctx, int8_t time_zone );
359
375void rtc6_enable_swo ( rtc6_t *ctx, uint8_t swo );
376
385
394
403void rtc6_get_gmt_time ( rtc6_t *ctx, rtc6_time_t *gmt_time );
404
413void rtc6_set_gmt_time ( rtc6_t *ctx, rtc6_time_t *set_time );
414
423void rtc6_get_local_time ( rtc6_t *ctx, rtc6_time_t *local_time );
424
435
446
456uint8_t rtc6_is_leap_year ( rtc6_t *ctx );
457
468
478
489void rtc6_set_alarm ( rtc6_t *ctx, uint8_t alarm, uint8_t trigger, rtc6_time_t *time );
490
499void rtc6_disable_alarm ( rtc6_t *ctx, uint8_t alarm );
500
510void rtc6_read_alarm ( rtc6_t *ctx, uint8_t alarm, rtc6_time_t *get_alarm );
511
522
532void rtc6_repeat_alarm ( rtc6_t *ctx, uint8_t alarm, uint32_t sec );
533
543void rtc6_write_sram ( rtc6_t *ctx, uint8_t addr, uint8_t data_in );
544
555uint8_t rtc6_read_sram ( rtc6_t *ctx, uint8_t addr );
556
565
574
583
594void rtc6_write_eeprom ( rtc6_t *ctx, uint8_t addr, void *data_in, uint8_t data_size );
595
606void rtc6_read_eeprom ( rtc6_t *ctx, uint8_t addr, void *data_out, uint8_t data_size );
607
617void rtc6_read_unique_id ( rtc6_t *ctx, uint8_t *unique_id );
618
619#ifdef __cplusplus
620}
621#endif
622#endif // _RTC6_H_
623 // End public_function group
626
627// ------------------------------------------------------------------------- END
#define RTC6_RETVAL
Definition: rtc6.h:168
void rtc6_generic_read(rtc6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void rtc6_get_last_power_failure(rtc6_t *ctx, rtc6_time_t *last_time)
Gets the time of the last power failure.
void rtc6_default_cfg(rtc6_t *ctx, int8_t time_zone, rtc6_time_t *utc_time, rtc6_time_t *alarm_time)
Click Default Configuration function.
void rtc6_generic_write(rtc6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void rtc6_cfg_setup(rtc6_cfg_t *cfg)
Config Object Initialization function.
uint8_t rtc6_eeprom_is_locked(rtc6_t *ctx)
Lock check function.
void rtc6_enable_swo(rtc6_t *ctx, uint8_t swo)
Enable Square Wave Output.
uint8_t rtc6_is_power_failure(rtc6_t *ctx)
Checks if a power failure has occured.
void rtc6_repeat_alarm(rtc6_t *ctx, uint8_t alarm, uint32_t sec)
Repeat Alarm.
void rtc6_write_eeprom(rtc6_t *ctx, uint8_t addr, void *data_in, uint8_t data_size)
Writes data to EEPROM.
void rtc6_get_local_time(rtc6_t *ctx, rtc6_time_t *local_time)
Calculates the current local time.
uint8_t rtc6_read_sram(rtc6_t *ctx, uint8_t addr)
Reads data from an SRAM.
void rtc6_get_gmt_time(rtc6_t *ctx, rtc6_time_t *gmt_time)
Gets the current GMT time set in the RTC.
uint8_t rtc6_is_leap_year(rtc6_t *ctx)
Checks if the current year is a leap one.
uint32_t rtc6_get_gmt_unix_time(rtc6_t *ctx)
Calculates the current GMT time in UNIX epoch time.
void rtc6_battery_enable(rtc6_t *ctx)
Enables automatic switch to battery.
void rtc6_read_unique_id(rtc6_t *ctx, uint8_t *unique_id)
Reads unique ID.
void rtc6_set_gmt_time(rtc6_t *ctx, rtc6_time_t *set_time)
Sets the UTC GMT time.
uint8_t rtc6_is_active_alarm(rtc6_t *ctx)
Check if the alarm is activated.
uint32_t rtc6_get_local_unix_time(rtc6_t *ctx)
Calculates the current local time in UNIX epoch time.
void rtc6_write_sram(rtc6_t *ctx, uint8_t addr, uint8_t data_in)
Writes data to the SRAM.
void rtc6_write_eeprom_protect_on(rtc6_t *ctx)
Write protect on.
void rtc6_read_alarm(rtc6_t *ctx, uint8_t alarm, rtc6_time_t *get_alarm)
Reads the alarm time.
uint8_t rtc6_init_fun(rtc6_t *ctx, int8_t time_zone)
void rtc6_read_eeprom(rtc6_t *ctx, uint8_t addr, void *data_out, uint8_t data_size)
Reads data from EEPROM.
void rtc6_disable_swo(rtc6_t *ctx)
Disables Square Wave Output.
void rtc6_disable_alarm(rtc6_t *ctx, uint8_t alarm)
Disables the alarm.
void rtc6_set_alarm(rtc6_t *ctx, uint8_t alarm, uint8_t trigger, rtc6_time_t *time)
Sets the desired alarm.
RTC6_RETVAL rtc6_init(rtc6_t *ctx, rtc6_cfg_t *cfg)
Initialization function.
void rtc6_write_eeprom_protect_off(rtc6_t *ctx)
Write protect off.
Click configuration structure definition.
Definition: rtc6.h:272
int8_t time_zone_cfg
Definition: rtc6.h:289
uint32_t i2c_speed
Definition: rtc6.h:284
pin_name_t scl
Definition: rtc6.h:275
pin_name_t int_pin
Definition: rtc6.h:280
pin_name_t sda
Definition: rtc6.h:276
uint8_t i2c_address
Definition: rtc6.h:285
Click ctx object definition.
Definition: rtc6.h:251
int8_t time_zone
Definition: rtc6.h:264
digital_in_t int_pin
Definition: rtc6.h:254
i2c_master_t i2c
Definition: rtc6.h:258
uint8_t slave_address
Definition: rtc6.h:262
Click time data object.
Definition: rtc6.h:236
uint8_t hours
Definition: rtc6.h:239
uint8_t monthday
Definition: rtc6.h:241
uint8_t month
Definition: rtc6.h:242
uint8_t seconds
Definition: rtc6.h:237
uint16_t year
Definition: rtc6.h:243
uint8_t minutes
Definition: rtc6.h:238
uint8_t weekdays
Definition: rtc6.h:240