rtc17  2.0.0.0
rtc17.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 RTC17_H
29 #define RTC17_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define RTC17_REG_SECOND_COUNTER 0x00
60 #define RTC17_REG_MINUTE_COUNTER 0x01
61 #define RTC17_REG_HOUR_COUNTER 0x02
62 #define RTC17_REG_DAY_OF_WEEK_COUNTER 0x03
63 #define RTC17_REG_DAY_COUNTER 0x04
64 #define RTC17_REG_MONTH_COUNTER 0x05
65 #define RTC17_REG_YEAR_COUNTER 0x06
66 #define RTC17_REG_OSC_ADJ 0x07
67 #define RTC17_REG_ALARM_W_MINUTE 0x08
68 #define RTC17_REG_ALARM_W_HOUR 0x09
69 #define RTC17_REG_ALARM_W_DAY_OF_WEEK 0x0A
70 #define RTC17_REG_ALARM_D_MINUTE 0x0B
71 #define RTC17_REG_ALARM_D_HOUR 0x0C
72 #define RTC17_REG_CONTROL1 0x0E
73 #define RTC17_REG_CONTROL2 0x0F
74  // rtc17_reg
76 
91 #define RTC17_CONTROL1_ALARM_W_DISABLE 0x00
92 #define RTC17_CONTROL1_ALARM_W_ENABLE 0x80
93 #define RTC17_CONTROL1_ALARM_D_DISABLE 0x00
94 #define RTC17_CONTROL1_ALARM_D_ENABLE 0x40
95 #define RTC17_CONTROL1_12HOUR_TIME 0x00
96 #define RTC17_CONTROL1_24HOUR_TIME 0x20
97 #define RTC17_CONTROL1_CLOCK1_ENABLE 0x00
98 #define RTC17_CONTROL1_CLOCK1_DISABLE 0x10
99 #define RTC17_CONTROL1_TEST_NORMAL 0x00
100 #define RTC17_CONTROL1_TEST_TEST 0x08
101 #define RTC17_CONTROL1_CT_OFF 0x00
102 #define RTC17_CONTROL1_CT_FIXED_L 0x01
103 #define RTC17_CONTROL1_CT_PULSE_2HZ 0x02
104 #define RTC17_CONTROL1_CT_PULSE_1HZ 0x03
105 #define RTC17_CONTROL1_CT_EVERY_SECOND 0x04
106 #define RTC17_CONTROL1_CT_EVERY_MINUTE 0x05
107 #define RTC17_CONTROL1_CT_EVERY_HOUR 0x06
108 #define RTC17_CONTROL1_CT_EVERY_MONTH 0x07
109 
114 #define RTC17_CONTROL2_VDSL_2p1V 0x00
115 #define RTC17_CONTROL2_VDSL_1p6V 0x80
116 #define RTC17_CONTROL2_VDET_ABOVE 0x00
117 #define RTC17_CONTROL2_VDET_BELOW 0x40
118 #define RTC17_CONTROL2_SCRATCH_BIT 0x20
119 #define RTC17_CONTROL2_XSTP_NORMAL 0x00
120 #define RTC17_CONTROL2_XSTP_HALT 0x10
121 #define RTC17_CONTROL2_CLOCK2_ENABLE 0x00
122 #define RTC17_CONTROL2_CLOCK2_DISABLE 0x08
123 #define RTC17_CONTROL2_CLEAR_INTERRUPT 0x04
124 #define RTC17_CONTROL2_CLEAR_ALARM_W 0x02
125 #define RTC17_CONTROL2_CLEAR_ALARM_D 0x01
126 
131 #define RTC17_MONDAY 0x00
132 #define RTC17_TUESDAY 0x01
133 #define RTC17_WEDNESDAY 0x02
134 #define RTC17_THURSDAY 0x03
135 #define RTC17_FRIDAY 0x04
136 #define RTC17_SATURDAY 0x05
137 #define RTC17_SUNDAY 0x06
138 
144 #define RTC17_SET_DEVICE_ADDRESS 0x32
145  // rtc17_set
147 
162 #define RTC17_MAP_MIKROBUS( cfg, mikrobus ) \
163  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
164  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
165  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
166  // rtc17_map // rtc17
169 
174 typedef struct
175 {
176  // Input pins
177  digital_in_t int_pin;
179  // Modules
180  i2c_master_t i2c;
182  // I2C slave address
183  uint8_t slave_address;
185 } rtc17_t;
186 
191 typedef struct
192 {
193  pin_name_t scl;
194  pin_name_t sda;
196  pin_name_t int_pin;
198  uint32_t i2c_speed;
199  uint8_t i2c_address;
201 } rtc17_cfg_t;
202 
208 typedef struct
209 {
210  uint8_t second;
211  uint8_t minute;
212  uint8_t hour;
213 
214 } rtc17_time_t;
215 
221 typedef struct
222 {
223  uint8_t day_of_week;
224  uint8_t day;
225  uint8_t month;
226  uint8_t year;
227 
228 } rtc17_date_t;
229 
234 typedef enum
235 {
236  RTC17_OK = 0,
237  RTC17_ERROR = -1
238 
240 
257 
271 err_t rtc17_init ( rtc17_t *ctx, rtc17_cfg_t *cfg );
272 
285 err_t rtc17_default_cfg ( rtc17_t *ctx );
286 
300 err_t rtc17_write_register ( rtc17_t *ctx, uint8_t reg, uint8_t data_in );
301 
316 err_t rtc17_write_multiple_registers ( rtc17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
317 
330 err_t rtc17_read_register ( rtc17_t *ctx, uint8_t reg, uint8_t *data_out );
331 
346 err_t rtc17_read_multiple_registers ( rtc17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
347 
356 uint8_t rtc17_get_int_pin ( rtc17_t *ctx );
357 
369 
382 err_t rtc17_set_time ( rtc17_t *ctx, rtc17_time_t *time );
383 
396 err_t rtc17_read_time ( rtc17_t *ctx, rtc17_time_t *time );
397 
410 err_t rtc17_set_date ( rtc17_t *ctx, rtc17_date_t *date );
411 
424 err_t rtc17_read_date ( rtc17_t *ctx, rtc17_date_t *date );
425 
426 #ifdef __cplusplus
427 }
428 #endif
429 #endif // RTC17_H
430  // rtc17
432 
433 // ------------------------------------------------------------------------ END
rtc17_date_t::day_of_week
uint8_t day_of_week
Definition: rtc17.h:223
rtc17_date_t::day
uint8_t day
Definition: rtc17.h:224
rtc17_time_t::second
uint8_t second
Definition: rtc17.h:210
rtc17_read_time
err_t rtc17_read_time(rtc17_t *ctx, rtc17_time_t *time)
RTC 17 read time function.
rtc17_return_value_t
rtc17_return_value_t
RTC 17 Click return value data.
Definition: rtc17.h:235
rtc17_cfg_t::int_pin
pin_name_t int_pin
Definition: rtc17.h:196
RTC17_OK
@ RTC17_OK
Definition: rtc17.h:236
rtc17_cfg_t::sda
pin_name_t sda
Definition: rtc17.h:194
rtc17_cfg_t::i2c_address
uint8_t i2c_address
Definition: rtc17.h:199
rtc17_date_t::month
uint8_t month
Definition: rtc17.h:225
rtc17_set_time
err_t rtc17_set_time(rtc17_t *ctx, rtc17_time_t *time)
RTC 17 set time function.
RTC17_ERROR
@ RTC17_ERROR
Definition: rtc17.h:237
rtc17_cfg_t::scl
pin_name_t scl
Definition: rtc17.h:193
rtc17_set_date
err_t rtc17_set_date(rtc17_t *ctx, rtc17_date_t *date)
RTC 17 set date function.
rtc17_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: rtc17.h:198
rtc17_clear_interrupts
err_t rtc17_clear_interrupts(rtc17_t *ctx)
RTC 17 clear interrupts function.
rtc17_t::i2c
i2c_master_t i2c
Definition: rtc17.h:180
rtc17_read_register
err_t rtc17_read_register(rtc17_t *ctx, uint8_t reg, uint8_t *data_out)
RTC 17 read register function.
rtc17_t::int_pin
digital_in_t int_pin
Definition: rtc17.h:177
rtc17_get_int_pin
uint8_t rtc17_get_int_pin(rtc17_t *ctx)
RTC 17 get int pin function.
rtc17_t
RTC 17 Click context object.
Definition: rtc17.h:175
rtc17_time_t
RTC 17 Click time object.
Definition: rtc17.h:209
rtc17_date_t::year
uint8_t year
Definition: rtc17.h:226
rtc17_cfg_t
RTC 17 Click configuration object.
Definition: rtc17.h:192
rtc17_time_t::minute
uint8_t minute
Definition: rtc17.h:211
rtc17_init
err_t rtc17_init(rtc17_t *ctx, rtc17_cfg_t *cfg)
RTC 17 initialization function.
rtc17_default_cfg
err_t rtc17_default_cfg(rtc17_t *ctx)
RTC 17 default configuration function.
rtc17_time_t::hour
uint8_t hour
Definition: rtc17.h:212
rtc17_date_t
RTC 17 Click date object.
Definition: rtc17.h:222
rtc17_write_multiple_registers
err_t rtc17_write_multiple_registers(rtc17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
RTC 17 write multiple registers function.
rtc17_cfg_setup
void rtc17_cfg_setup(rtc17_cfg_t *cfg)
RTC 17 configuration object setup function.
rtc17_read_date
err_t rtc17_read_date(rtc17_t *ctx, rtc17_date_t *date)
RTC 17 read date function.
rtc17_write_register
err_t rtc17_write_register(rtc17_t *ctx, uint8_t reg, uint8_t data_in)
RTC 17 write register function.
rtc17_t::slave_address
uint8_t slave_address
Definition: rtc17.h:183
rtc17_read_multiple_registers
err_t rtc17_read_multiple_registers(rtc17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
RTC 17 read multiple registers function.