rtc7  2.0.0.0
rtc7.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 RTC7_H
35 #define RTC7_H
36 
37 #include "drv_digital_out.h"
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define RTC7_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.itb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.ita = MIKROBUS( mikrobus, MIKROBUS_INT );
57 
63 #define RTC7_RETVAL uint8_t
64 
65 #define RTC7_OK 0x00
66 #define RTC7_INIT_ERROR 0xFF
67 
73 #define RTC7_SECONDS_ADDR 0x06
74 #define RTC7_MINUTES_ADDR 0x07
75 #define RTC7_HOURS_ADDR 0x08
76 #define RTC7_DAY_ADDR 0x09
77 #define RTC7_DATE_ADDR 0x0A
78 #define RTC7_MONTH_ADDR 0x0B
79 #define RTC7_YEAR_ADDR 0x0C
80 
86 #define RTC7_TIMEDATE_BYTES 7
87 #define RTC7_SECONDS_BYTE 0
88 #define RTC7_MINUTES_BYTE 1
89 #define RTC7_HOURS_BYTE 2
90 #define RTC7_DAY_BYTE 3
91 #define RTC7_DATE_BYTE 4
92 #define RTC7_MONTH_BYTE 5
93 #define RTC7_YEAR_BYTE 6
94 
100 #define RTC7_SECONDS_MASK 0x7F
101 #define RTC7_MINUTES_MASK 0x7F
102 #define RTC7_HOURS_MASK 0x1F
103 #define RTC7_DAY_MASK 0x07
104 #define RTC7_DATE_MASK 0x3F
105 #define RTC7_MONTH_MASK 0x1F
106 #define RTC7_YEAR_MASK 0xFF
107 
113 #define RTC7_JULIAN_DAY_1970 2440588
114 #define RTC7_TIME_SEC_IN_MIN 60
115 #define RTC7_TIME_SEC_IN_HOUR 3600
116 #define RTC7_TIME_SEC_IN_24_HOURS 86400
117 
123 #define RTC7_CONFIG1_REG 0x00
124 #define RTC7_CONFIG2_REG 0x01
125 #define RTC7_SLEEP_CONFIG_REG 0x02
126 #define RTC7_TIMER_CONFIG_REG 0x03
127 #define RTC7_INT_EN_REG 0x04
128 #define RTC7_INT_STATUS_REG 0x05
129 #define RTC7_ALM1_SEC_REG 0x0D
130 #define RTC7_ALM1_MIN_REG 0x0E
131 #define RTC7_ALM1_HRS_REG 0x0F
132 #define RTC7_ALM1_DAY_DATE_REG 0x10
133 #define RTC7_ALM2_MIN_REG 0x11
134 #define RTC7_ALM2_HRS_REG 0x12
135 #define RTC7_ALM2_DAY_DATE_REG 0x13
136 #define RTC7_TIMER_COUNT_REG 0x14
137 #define RTC7_TIMER_INIT_REG 0x15
138 #define RTC7_RAM0_REG_ADDR16H 0x16
139 #define RTC7_RAM63_REG_ADDR55H 0x55
140 #define RTC7_PWR_MGMT_REG 0x56
141 #define RTC7_TRICKLE_REG 0x57
142 #define RTC7_SPARE_REG 0x58
143 #define RTC7_SPARE_ST_REG 0x59
144 #define RTC7_TEST1_REG 0x64
145 #define RTC7_TEST2_REG 0x65
146 #define RTC7_TEST3_REG 0x66
147 #define RTC7_TCFG1_REG 0x67
148 #define RTC7_TCFG2_REG 0x68
149 #define RTC7_TCFG3_REG 0x69
150 #define RTC7_OTP1_B1_REG 0x6A
151 #define RTC7_OTP1_B2_REG 0x6B
152 #define RTC7_OTP1_B3_REG 0x6C
153 #define RTC7_OTP1_B4_REG 0x6D
154 #define RTC7_OTP2_B1_REG 0x6E
155 #define RTC7_OTP2_B2_REG 0x6F
156 #define RTC7_OTP2_B3_REG 0x70
157 #define RTC7_OTP2_B4_REG 0x71
158 #define RTC7_TCFG4_REG 0x72
159 #define RTC7_TCFG5_REG 0x73
160 #define RTC7_TEST_DIG_REG 0x74
161 
167 #define RTC7_RESET_DIGITAL_BLOCK 0x00
168 #define RTC7_NOT_RESET_DIGITAL_BLOCK 0x01
169 #define RTC7_OUTPUT_FREQ_1HZ 0x00
170 #define RTC7_OUTPUT_FREQ_4098HZ 0x02
171 #define RTC7_OUTPUT_FREQ_8192HZ 0x04
172 #define RTC7_OUTPUT_FREQ_32768HZ 0x06
173 #define RTC7_ENABLE_OSC 0x00
174 #define RTC7_DISABLE_OSC 0x08
175 #define RTC7_INPUT_FREQ_1HZ 0x00
176 #define RTC7_INPUT_FREQ_50HZ 0x10
177 #define RTC7_INPUT_FREQ_60HZ 0x20
178 #define RTC7_INPUT_FREQ_32768HZ 0x30
179 #define RTC7_OUTPUT_SQUARE_WAVE 0x00
180 #define RTC7_OUTPUT_INTERRUPT 0x40
181 #define RTC7_DISABLE_EXT_CLOCK 0x00
182 #define RTC7_ENABLE_EXT_CLOCK 0x80
183 
189 #define RTC7_SOLAR_MODE 0x00
190 #define RTC7_LUNAR_MODE 0x01
191 #define RTC7_WRITE_NOT_ALLOW 0x00
192 #define RTC7_WRITE_ALLOW 0x02
193 #define RTC7_READ_NOT_ALLOW 0x00
194 #define RTC7_READ_ALLOW 0x04
195 #define RTC7_I2C_TIMEOUT_DIS 0x00
196 #define RTC7_I2C_TIMEOUT_EN 0x08
197 #define RTC7_VOLTAGE_THRESH_1400MV 0x00
198 #define RTC7_VOLTAGE_THRESH_1800MV 0x10
199 #define RTC7_VOLTAGE_THRESH_2100MV 0x20
200 #define RTC7_VOLTAGE_THRESH_2500MV 0x30
201 #define RTC7_NORMAL_OP_MODE 0x00
202 #define RTC7_DATA_RETENTION_MODE 0x40
203 
209 #define RTC7_SLEEP_PERIOD_NO_DELAY 0x00
210 #define RTC7_SLEEP_PERIOD_8_TO_16MS 0x01
211 #define RTC7_SLEEP_PERIOD_16_TO_24MS 0x02
212 #define RTC7_SLEEP_PERIOD_24_TO_32MS 0x03
213 #define RTC7_SLEEP_PERIOD_32_TO_40MS 0x04
214 #define RTC7_SLEEP_PERIOD_40_TO_48MS 0x05
215 #define RTC7_SLEEP_PERIOD_48_TO_56MS 0x06
216 #define RTC7_SLEEP_PERIOD_56_TO_64MS 0x07
217 #define RTC7_SLEEP_MANAGER_DIS 0x00
218 #define RTC7_SLEEP_MANAGER_EN 0x08
219 #define RTC7_DIN0_INTERR_FALL_EDGE 0x00
220 #define RTC7_DIN0_INTERR_RISE_EDGE 0x10
221 #define RTC7_DIN1_INTERR_FALL_EDGE 0x00
222 #define RTC7_DIN1_INTERR_RISE_EDGE 0x20
223 #define RTC7_AN_INTERR_FALL_EDGE 0x00
224 #define RTC7_AN_INTERR_RISE_EDGE 0x40
225 #define RTC7_SLEEP_MODE_DIS 0x00
226 #define RTC7_SLEEP_MODE_EN 0x80
227 
233 #define RTC7_TIMER_FREQ_1024HZ 0x00
234 #define RTC7_TIMER_FREQ_256HZ 0x01
235 #define RTC7_TIMER_FREQ_64HZ 0x02
236 #define RTC7_TIMER_FREQ_16HZ 0x03
237 #define RTC7_TIMER_WILL_HALT 0x00
238 #define RTC7_TIMER_RELOADS_VALUE 0x04
239 #define RTC7_PULSE_INTERR_TM_IS_0 0x00
240 #define RTC7_PULSE_INTERR_TM_IS_1 0x08
241 #define RTC7_TIMER_DIS 0x00
242 #define RTC7_TIMER_EN 0x10
243 
249 #define RTC7_ALARM1_INTERR_DIS 0x00
250 #define RTC7_ALARM1_INTERR_EN 0x01
251 #define RTC7_ALARM2_INTERR_DIS 0x00
252 #define RTC7_ALARM2_INTERR_EN 0x02
253 #define RTC7_TIMER_INTERR_DIS 0x00
254 #define RTC7_TIMER_INTERR_EN 0x04
255 #define RTC7_EXT_INTERR0_DIS 0x00
256 #define RTC7_EXT_INTERR0_EN 0x08
257 #define RTC7_EXT_INTERR1_DIS 0x00
258 #define RTC7_EXT_INTERR1_EN 0x10
259 #define RTC7_AN_INTERR_DIS 0x00
260 #define RTC7_AN_INTERR_EN 0x20
261 
267 #define RTC7_INDICATES_AM 0x00
268 #define RTC7_INDICATES_PM 0x20
269 #define RTC7_24HR_FORMAT 0x00
270 #define RTC7_12HR_FORMAT 0x40
271  // End group macro
274 // --------------------------------------------------------------- PUBLIC TYPES
280 typedef struct
281 {
282  uint8_t seconds;
283  uint8_t minutes;
284  uint8_t hours;
285  uint8_t weekdays;
286  uint8_t monthday;
287  uint8_t month;
288  uint8_t year;
289 }rtc7_time_t;
290 
291 
295 typedef struct
296 {
297  // Input pins
298 
299  digital_in_t itb;
300  digital_in_t rst;
301  digital_in_t ita;
302 
303  // Modules
304 
305  i2c_master_t i2c;
306 
307  // ctx variable
308 
309  uint8_t slave_address;
310 
313  uint8_t dst_enabled;
314  uint8_t hours_check;
315  uint8_t val_pom;
316  uint8_t val_pom1;
317  uint8_t current_zone;
318  uint8_t cycle_check;
319  uint8_t rtc7_am_pm;
321  uint8_t rtc7_century;
323 
324 } rtc7_t;
325 
329 typedef struct
330 {
331  // Communication gpio pins
332 
333  pin_name_t scl;
334  pin_name_t sda;
335 
336  // Additional gpio pins
337 
338  pin_name_t itb;
339  pin_name_t rst;
340  pin_name_t ita;
341 
342  // static variable
343 
344  uint32_t i2c_speed;
345  uint8_t i2c_address;
346 
347 } rtc7_cfg_t;
348  // End types group
350 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
351 
357 #ifdef __cplusplus
358 extern "C"{
359 #endif
360 
369 void rtc7_cfg_setup ( rtc7_cfg_t *cfg );
370 
379 RTC7_RETVAL rtc7_init ( rtc7_t *ctx, rtc7_cfg_t *cfg );
380 
391 void rtc7_generic_write ( rtc7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
392 
403 void rtc7_generic_read ( rtc7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
404 
414 uint8_t rtc7_write_reg ( rtc7_t *ctx, uint8_t register_address, uint8_t transfer_data );
415 
426 uint8_t rtc7_read_reg ( rtc7_t *ctx, uint8_t register_address, uint8_t n_bytes, uint8_t *data_out );
427 
437 uint8_t rtc7_init_time ( rtc7_t *ctx, int8_t time_zone, uint8_t time_mode );
438 
446 void rtc7_enable_dst ( rtc7_t *ctx );
447 
455 void rtc7_disable_dst ( rtc7_t *ctx );
456 
467 uint8_t rtc7_set_osc ( rtc7_t *ctx, uint8_t enable_osc, uint8_t clk_in, uint8_t clk_out );
468 
478 uint8_t rtc7_set_timer ( rtc7_t *ctx, uint8_t enable_timer, uint8_t timer_freq );
479 
487 void rtc7_reset ( rtc7_t *ctx );
488 
497 void rtc7_get_gmt_time ( rtc7_t *ctx, rtc7_time_t *gmt_time );
498 
508 void rtc7_get_local_time ( rtc7_t *ctx, rtc7_time_t *local_time );
509 
518 uint8_t rtc7_set_gmt_time( rtc7_t *ctx, rtc7_time_t *time );
519 
528 uint8_t rtc7_check_interr ( rtc7_t *ctx );
529 
537 uint8_t rtc7_check_psw ( rtc7_t *ctx );
538 
539 #ifdef __cplusplus
540 }
541 #endif
542 #endif // _RTC7_H_
543  // End public_function group
546 
547 // ------------------------------------------------------------------------- END
rtc7_time_t::year
uint8_t year
Definition: rtc7.h:288
rtc7_cfg_t::scl
pin_name_t scl
Definition: rtc7.h:333
rtc7_t::rst
digital_in_t rst
Definition: rtc7.h:300
rtc7_init_time
uint8_t rtc7_init_time(rtc7_t *ctx, int8_t time_zone, uint8_t time_mode)
Initialization function.
rtc7_t::rtc7_century
uint8_t rtc7_century
Definition: rtc7.h:321
rtc7_time_t::monthday
uint8_t monthday
Definition: rtc7.h:286
rtc7_cfg_t::i2c_address
uint8_t i2c_address
Definition: rtc7.h:345
rtc7_get_gmt_time
void rtc7_get_gmt_time(rtc7_t *ctx, rtc7_time_t *gmt_time)
Get Gmt Time function.
rtc7_t::rtc7_month_mode
uint8_t rtc7_month_mode
Definition: rtc7.h:320
RTC7_RETVAL
#define RTC7_RETVAL
Definition: rtc7.h:63
rtc7_t::cycle_check
uint8_t cycle_check
Definition: rtc7.h:318
rtc7_time_t::hours
uint8_t hours
Definition: rtc7.h:284
rtc7_cfg_t::itb
pin_name_t itb
Definition: rtc7.h:338
rtc7_enable_dst
void rtc7_enable_dst(rtc7_t *ctx)
Distance Enable function.
rtc7_t::val_pom
uint8_t val_pom
Definition: rtc7.h:315
rtc7_t::rtc7_am_pm
uint8_t rtc7_am_pm
Definition: rtc7.h:319
rtc7_t::time_set_tmp
rtc7_time_t * time_set_tmp
Definition: rtc7.h:322
rtc7_time_t
Definition: rtc7.h:280
rtc7_cfg_t
Click configuration structure definition.
Definition: rtc7.h:329
rtc7_cfg_t::ita
pin_name_t ita
Definition: rtc7.h:340
rtc7_set_osc
uint8_t rtc7_set_osc(rtc7_t *ctx, uint8_t enable_osc, uint8_t clk_in, uint8_t clk_out)
Oscillator Set function.
rtc7_generic_read
void rtc7_generic_read(rtc7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
rtc7_disable_dst
void rtc7_disable_dst(rtc7_t *ctx)
Distance Disable function.
rtc7_init
RTC7_RETVAL rtc7_init(rtc7_t *ctx, rtc7_cfg_t *cfg)
Initialization function.
rtc7_generic_write
void rtc7_generic_write(rtc7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
rtc7_set_timer
uint8_t rtc7_set_timer(rtc7_t *ctx, uint8_t enable_timer, uint8_t timer_freq)
Timer Set function.
rtc7_t::itb
digital_in_t itb
Definition: rtc7.h:299
rtc7_t::current_zone
uint8_t current_zone
Definition: rtc7.h:317
rtc7_reset
void rtc7_reset(rtc7_t *ctx)
Reset function.
rtc7_time_t::seconds
uint8_t seconds
Definition: rtc7.h:282
rtc7_t
Click ctx object definition.
Definition: rtc7.h:295
rtc7_t::hours_check
uint8_t hours_check
Definition: rtc7.h:314
rtc7_t::dst_enabled
uint8_t dst_enabled
Definition: rtc7.h:313
rtc7_time_t::minutes
uint8_t minutes
Definition: rtc7.h:283
rtc7_t::current_time_zone
int8_t current_time_zone
Definition: rtc7.h:312
rtc7_cfg_t::sda
pin_name_t sda
Definition: rtc7.h:334
rtc7_write_reg
uint8_t rtc7_write_reg(rtc7_t *ctx, uint8_t register_address, uint8_t transfer_data)
Write one byte function.
rtc7_check_interr
uint8_t rtc7_check_interr(rtc7_t *ctx)
Interrupt Check function.
rtc7_time_t::month
uint8_t month
Definition: rtc7.h:287
rtc7_t::slave_address
uint8_t slave_address
Definition: rtc7.h:309
rtc7_check_psw
uint8_t rtc7_check_psw(rtc7_t *ctx)
Power Switch Control function.
rtc7_t::i2c
i2c_master_t i2c
Definition: rtc7.h:305
rtc7_cfg_setup
void rtc7_cfg_setup(rtc7_cfg_t *cfg)
Config Object Initialization function.
rtc7_read_reg
uint8_t rtc7_read_reg(rtc7_t *ctx, uint8_t register_address, uint8_t n_bytes, uint8_t *data_out)
Read one byte function.
rtc7_t::current_local_time
rtc7_time_t current_local_time
Definition: rtc7.h:311
rtc7_cfg_t::rst
pin_name_t rst
Definition: rtc7.h:339
rtc7_t::ita
digital_in_t ita
Definition: rtc7.h:301
rtc7_t::val_pom1
uint8_t val_pom1
Definition: rtc7.h:316
rtc7_set_gmt_time
uint8_t rtc7_set_gmt_time(rtc7_t *ctx, rtc7_time_t *time)
Set Gmt Time function.
rtc7_get_local_time
void rtc7_get_local_time(rtc7_t *ctx, rtc7_time_t *local_time)
Get Local Time function.
rtc7_time_t::weekdays
uint8_t weekdays
Definition: rtc7.h:285
rtc7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: rtc7.h:344