rtc14  2.0.0.0
rtc14.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef RTC14_H
29 #define RTC14_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define RTC14_REG_SC 0x00
74 #define RTC14_REG_MN 0x01
75 #define RTC14_REG_HR 0x02
76 #define RTC14_REG_DT 0x03
77 #define RTC14_REG_MO 0x04
78 #define RTC14_REG_YR 0x05
79 #define RTC14_REG_DW 0x06
80 #define RTC14_REG_SR 0x07
81 #define RTC14_REG_INT 0x08
82 #define RTC14_REG_ATR 0x0A
83 #define RTC14_REG_DTR 0x0B
84 #define RTC14_REG_SCA 0x0C
85 #define RTC14_REG_MNA 0x0D
86 #define RTC14_REG_HRA 0x0E
87 #define RTC14_REG_DTA 0x0F
88 #define RTC14_REG_MOA 0x10
89 #define RTC14_REG_DWA 0x11
90 #define RTC14_REG_USR1 0x12
91 #define RTC14_REG_USR2 0x13
92 #define RTC14_REG_SCT 0x14
93 #define RTC14_REG_MNT 0x15
94 #define RTC14_REG_HRT 0x16
95 #define RTC14_REG_DTT 0x17
96 #define RTC14_REG_MOT 0x18
97 #define RTC14_REG_YRT 0x19
98  // rtc14_reg
100 
115 #define RTC14_SET_HOURS_FORMAT_12 0x00
116 #define RTC14_SET_HOURS_FORMAT_24 0x80
117 #define RTC14_SET_HOURS_FORMAT_12_AM 0x00
118 #define RTC14_SET_HOURS_FORMAT_12_PM 0x20
119 #define RTC14_SET_ALARM_ENABLE 0x80
120 #define RTC14_SET_INT_ENABLE 0x40
121 #define RTC14_SET_SOFT_RESET 0x80
122 #define RTC14_SET_ENABLE_WRTC 0x10
123 
128 #define RTC14_DW_SUNDAY 0x00
129 #define RTC14_DW_MONDAY 0x01
130 #define RTC14_DW_TUESDAY 0x02
131 #define RTC14_DW_WEDNESDAY 0x03
132 #define RTC14_DW_THURSDAY 0x04
133 #define RTC14_DW_FRIDAY 0x05
134 #define RTC14_DW_SATURDAY 0x06
135 
141 #define RTC14_SET_DEV_ADDR 0x6F
142  // rtc14_set
144 
159 #define RTC14_MAP_MIKROBUS( cfg, mikrobus ) \
160  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
161  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
162  cfg.fo = MIKROBUS( mikrobus, MIKROBUS_AN ); \
163  cfg.ein = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
164  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
165  // rtc14_map // rtc14
168 
173 typedef struct
174 {
175  // Output pins
176  digital_out_t ein;
178  // Input pins
179  digital_in_t fo;
180  digital_in_t int_pin;
182  // Modules
183  i2c_master_t i2c;
185  // I2C slave address
186  uint8_t slave_address;
188 } rtc14_t;
189 
194 typedef struct
195 {
196  pin_name_t scl;
197  pin_name_t sda;
199  pin_name_t fo;
200  pin_name_t ein;
201  pin_name_t int_pin;
203  uint32_t i2c_speed;
204  uint8_t i2c_address;
206 } rtc14_cfg_t;
207 
212 typedef struct
213 {
214  uint8_t hours_format;
215  uint8_t am_pm;
216  uint8_t hours;
217  uint8_t min;
218  uint8_t sec;
219 
220 } rtc14_time_t;
221 
226 typedef struct
227 {
228  uint8_t year;
229  uint8_t month;
230  uint8_t day;
231  uint8_t day_of_week;
232 
233 
234 } rtc14_date_t;
235 
240 typedef struct
241 {
242  uint8_t sec;
243  uint8_t min;
244  uint8_t hours;
245  uint8_t day;
246  uint8_t month;
247  uint8_t day_of_week;
248 
249 } rtc14_alarm_t;
250 
255 typedef struct
256 {
257  uint8_t sec;
258  uint8_t min;
259  uint8_t hours;
260  uint8_t day;
261  uint8_t month;
262  uint8_t year;
263 
265 
270 typedef enum
271 {
272  RTC14_OK = 0,
273  RTC14_ERROR = -1
274 
276 
295 
312 err_t rtc14_init ( rtc14_t *ctx, rtc14_cfg_t *cfg );
313 
329 err_t rtc14_default_cfg ( rtc14_t *ctx );
330 
348 err_t rtc14_generic_write ( rtc14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
349 
367 err_t rtc14_generic_read ( rtc14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
368 
385 err_t rtc14_write_sram ( rtc14_t *ctx, uint16_t sram_data_in );
386 
403 err_t rtc14_read_sram ( rtc14_t *ctx, uint16_t *sram_data_out );
404 
419 uint8_t rtc14_get_interrupt ( rtc14_t *ctx );
420 
435 uint8_t rtc14_get_fout ( rtc14_t *ctx );
436 
452 err_t rtc14_enable_rtc ( rtc14_t *ctx );
453 
469 err_t rtc14_soft_reset ( rtc14_t *ctx );
470 
487 err_t rtc14_get_time ( rtc14_t *ctx, rtc14_time_t *rtc_time );
488 
505 err_t rtc14_set_time ( rtc14_t *ctx, rtc14_time_t rtc_time );
506 
523 err_t rtc14_get_date ( rtc14_t *ctx, rtc14_date_t *rtc_date );
524 
541 err_t rtc14_set_date ( rtc14_t *ctx, rtc14_date_t rtc_date );
542 
559 err_t rtc14_get_alarm ( rtc14_t *ctx, rtc14_alarm_t *rtc_alarm );
560 
577 err_t rtc14_set_alarm ( rtc14_t *ctx, rtc14_alarm_t rtc_alarm );
578 
592 
609 err_t rtc14_get_time_stamp ( rtc14_t *ctx, rtc14_time_stamp_t *rtc_time_stamp );
610 
611 #ifdef __cplusplus
612 }
613 #endif
614 #endif // RTC14_H
615  // rtc14
617 
618 // ------------------------------------------------------------------------ END
rtc14_time_stamp_t::min
uint8_t min
Definition: rtc14.h:258
rtc14_write_sram
err_t rtc14_write_sram(rtc14_t *ctx, uint16_t sram_data_in)
RTC 14 write SRAM function.
rtc14_generic_write
err_t rtc14_generic_write(rtc14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
RTC 14 I2C writing function.
rtc14_generic_read
err_t rtc14_generic_read(rtc14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
RTC 14 I2C reading function.
rtc14_t::int_pin
digital_in_t int_pin
Definition: rtc14.h:180
rtc14_get_interrupt
uint8_t rtc14_get_interrupt(rtc14_t *ctx)
RTC 14 get interrupt function.
rtc14_time_stamp_t::day
uint8_t day
Definition: rtc14.h:260
rtc14_alarm_t::day_of_week
uint8_t day_of_week
Definition: rtc14.h:247
rtc14_get_time
err_t rtc14_get_time(rtc14_t *ctx, rtc14_time_t *rtc_time)
RTC 14 get time function.
rtc14_time_t::am_pm
uint8_t am_pm
Definition: rtc14.h:215
rtc14_time_stamp_t::sec
uint8_t sec
Definition: rtc14.h:257
rtc14_return_value_t
rtc14_return_value_t
RTC 14 Click return value data.
Definition: rtc14.h:271
rtc14_get_time_stamp
err_t rtc14_get_time_stamp(rtc14_t *ctx, rtc14_time_stamp_t *rtc_time_stamp)
RTC 14 get time stamp function.
rtc14_cfg_t::ein
pin_name_t ein
Definition: rtc14.h:200
RTC14_ERROR
@ RTC14_ERROR
Definition: rtc14.h:273
rtc14_get_alarm
err_t rtc14_get_alarm(rtc14_t *ctx, rtc14_alarm_t *rtc_alarm)
RTC 14 get alarm function.
rtc14_date_t::month
uint8_t month
Definition: rtc14.h:229
rtc14_init
err_t rtc14_init(rtc14_t *ctx, rtc14_cfg_t *cfg)
RTC 14 initialization function.
rtc14_date_t::year
uint8_t year
Definition: rtc14.h:228
rtc14_get_date
err_t rtc14_get_date(rtc14_t *ctx, rtc14_date_t *rtc_date)
RTC 14 get date function.
rtc14_t::slave_address
uint8_t slave_address
Definition: rtc14.h:186
rtc14_get_fout
uint8_t rtc14_get_fout(rtc14_t *ctx)
RTC 14 get fout function.
rtc14_cfg_t::sda
pin_name_t sda
Definition: rtc14.h:197
rtc14_date_t::day
uint8_t day
Definition: rtc14.h:230
rtc14_time_stamp_t::hours
uint8_t hours
Definition: rtc14.h:259
RTC14_OK
@ RTC14_OK
Definition: rtc14.h:272
rtc14_time_stamp_t::month
uint8_t month
Definition: rtc14.h:261
rtc14_time_t::min
uint8_t min
Definition: rtc14.h:217
rtc14_alarm_t::min
uint8_t min
Definition: rtc14.h:243
rtc14_set_alarm
err_t rtc14_set_alarm(rtc14_t *ctx, rtc14_alarm_t rtc_alarm)
RTC 14 set alarm function.
rtc14_set_time
err_t rtc14_set_time(rtc14_t *ctx, rtc14_time_t rtc_time)
RTC 14 set time function.
rtc14_alarm_t
RTC 14 Click alarm object.
Definition: rtc14.h:241
rtc14_alarm_t::month
uint8_t month
Definition: rtc14.h:246
rtc14_t
RTC 14 Click context object.
Definition: rtc14.h:174
rtc14_time_t
RTC 14 Click time object.
Definition: rtc14.h:213
rtc14_cfg_t
RTC 14 Click configuration object.
Definition: rtc14.h:195
rtc14_cfg_t::int_pin
pin_name_t int_pin
Definition: rtc14.h:201
rtc14_alarm_t::hours
uint8_t hours
Definition: rtc14.h:244
rtc14_trigger_time_stamp
void rtc14_trigger_time_stamp(rtc14_t *ctx)
RTC 14 trigger time stamp function.
rtc14_default_cfg
err_t rtc14_default_cfg(rtc14_t *ctx)
RTC 14 default configuration function.
rtc14_time_stamp_t
RTC 14 Click time stamp object.
Definition: rtc14.h:256
rtc14_time_t::hours
uint8_t hours
Definition: rtc14.h:216
rtc14_set_date
err_t rtc14_set_date(rtc14_t *ctx, rtc14_date_t rtc_date)
RTC 14 set date function.
rtc14_alarm_t::day
uint8_t day
Definition: rtc14.h:245
rtc14_soft_reset
err_t rtc14_soft_reset(rtc14_t *ctx)
RTC 14 soft reset function.
rtc14_date_t
RTC 14 Click date object.
Definition: rtc14.h:227
rtc14_enable_rtc
err_t rtc14_enable_rtc(rtc14_t *ctx)
RTC 14 enable RTC function.
rtc14_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: rtc14.h:203
rtc14_time_t::hours_format
uint8_t hours_format
Definition: rtc14.h:214
rtc14_alarm_t::sec
uint8_t sec
Definition: rtc14.h:242
rtc14_read_sram
err_t rtc14_read_sram(rtc14_t *ctx, uint16_t *sram_data_out)
RTC 14 I2C reading SRAM function.
rtc14_t::ein
digital_out_t ein
Definition: rtc14.h:176
rtc14_cfg_setup
void rtc14_cfg_setup(rtc14_cfg_t *cfg)
RTC 14 configuration object setup function.
rtc14_time_stamp_t::year
uint8_t year
Definition: rtc14.h:262
rtc14_cfg_t::i2c_address
uint8_t i2c_address
Definition: rtc14.h:204
rtc14_cfg_t::scl
pin_name_t scl
Definition: rtc14.h:196
rtc14_date_t::day_of_week
uint8_t day_of_week
Definition: rtc14.h:231
rtc14_t::i2c
i2c_master_t i2c
Definition: rtc14.h:183
rtc14_time_t::sec
uint8_t sec
Definition: rtc14.h:218
rtc14_t::fo
digital_in_t fo
Definition: rtc14.h:179
rtc14_cfg_t::fo
pin_name_t fo
Definition: rtc14.h:199