rtc12 2.0.0.0
rtc12.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 RTC12_H
29#define RTC12_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_spi_master.h"
38
39
60#define RTC12_REG_SECONDS 0x00
61#define RTC12_REG_MINUTES 0x01
62#define RTC12_REG_HOUR 0x02
63#define RTC12_REG_DAY 0x03
64#define RTC12_REG_DATE 0x04
65#define RTC12_REG_MONTH 0x05
66#define RTC12_REG_YEAR 0x06
67#define RTC12_REG_ALARM_0_SECONDS 0x07
68#define RTC12_REG_ALARM_0_MINUTES 0x08
69#define RTC12_REG_ALARM_0_HOUR 0x09
70#define RTC12_REG_ALARM_0_DAY 0x0A
71#define RTC12_REG_ALARM_1_SECONDS 0x0B
72#define RTC12_REG_ALARM_1_MINUTES 0x0C
73#define RTC12_REG_ALARM_1_HOUR 0x0D
74#define RTC12_REG_ALARM_1_DAY 0x0E
75#define RTC12_REG_CONTROL 0x0F
76#define RTC12_REG_STATUS 0x10
77#define RTC12_REG_TRICKLE_CHARGER 0x11
78 // rtc12_reg
80
95#define RTC12_SET_EOSC_ENABLE 0x00
96#define RTC12_SET_EOSC_DISABLE 0x01
97#define RTC12_SET_DOSF_ENABLE 0x00
98#define RTC12_SET_DOSF_DISABL 0x01
99#define RTC12_SET_EGFIL_DISABLE 0x00
100#define RTC12_SET_EGFIL_ENABLE 0x01
101#define RTC12_SET_SQW_DISABLE 0x00
102#define RTC12_SET_SQW_ENABLE 0x01
103#define RTC12_SET_INTCN_A0IE 0x00
104#define RTC12_SET_INTCN_A0IE_A1IE 0x01
105#define RTC12_SET_ALARM_1_DISABLE 0x00
106#define RTC12_SET_ALARM_1_ENABLE 0x01
107#define RTC12_SET_ALARM_0_DISABLE 0x00
108#define RTC12_SET_ALARM_0_ENABLE 0x01
109
110 // rtc12_set
112
127#define RTC12_MAP_MIKROBUS( cfg, mikrobus ) \
128 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
129 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
130 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
131 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
132 cfg.pf = MIKROBUS( mikrobus, MIKROBUS_AN ); \
133 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
134 // rtc12_map // rtc12
137
142typedef struct
143{
144 // Input pins
145
146 digital_in_t pf;
147 digital_in_t int_pin;
149 // Modules
150
151 spi_master_t spi;
153 pin_name_t chip_select;
155} rtc12_t;
156
161typedef struct
162{
163 // Communication gpio pins
164
165 pin_name_t miso;
166 pin_name_t mosi;
167 pin_name_t sck;
168 pin_name_t cs;
170 // Additional gpio pins
171
172 pin_name_t pf;
173 pin_name_t int_pin;
175 // static variable
176
177 uint32_t spi_speed;
178 spi_master_mode_t spi_mode;
179 spi_master_chip_select_polarity_t cs_polarity;
182
187typedef struct
188{
189 uint8_t hours;
190 uint8_t min;
191 uint8_t sec;
192
194
199typedef struct
200{
201 uint8_t year;
202 uint8_t month;
203 uint8_t day;
204 uint8_t day_of_week;
205
206
208
213typedef struct
214{
215 uint8_t day;
216 uint8_t hours;
217 uint8_t min;
218 uint8_t sec;
219 uint8_t alarm_rate;
220
222
227typedef struct
228{
229 uint8_t eosc;
230 uint8_t dosf;
231 uint8_t egfil;
232 uint8_t sqw;
233 uint8_t intcn;
234 uint8_t a1ie;
235 uint8_t a0ie;
236
238
239
244typedef enum
245{
247 RTC12_ERROR = -1
248
250
267
282err_t rtc12_init ( rtc12_t *ctx, rtc12_cfg_t *cfg );
283
298
314err_t rtc12_generic_write ( rtc12_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
315
331err_t rtc12_generic_read ( rtc12_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
332
348
364
379err_t rtc12_get_time ( rtc12_t *ctx, rtc12_time_t *rtc_time );
380
395err_t rtc12_set_time ( rtc12_t *ctx, rtc12_time_t rtc_time );
396
411err_t rtc12_get_date ( rtc12_t *ctx, rtc12_date_t *rtc_date );
412
427err_t rtc12_set_date ( rtc12_t *ctx, rtc12_date_t rtc_date );
428
443err_t rtc12_get_alarm_0 ( rtc12_t *ctx, rtc12_alarm_t *rtc_alarm );
444
459err_t rtc12_set_alarm_0 ( rtc12_t *ctx, rtc12_alarm_t rtc_alarm );
460
475err_t rtc12_get_alarm_1 ( rtc12_t *ctx, rtc12_alarm_t *rtc_alarm );
476
491err_t rtc12_set_alarm_1 ( rtc12_t *ctx, rtc12_alarm_t rtc_alarm );
492
506uint8_t rtc12_check_int ( rtc12_t *ctx );
507
522
523#ifdef __cplusplus
524}
525#endif
526#endif // RTC12_H
527 // rtc12
529
530// ------------------------------------------------------------------------ END
err_t rtc12_set_alarm_0(rtc12_t *ctx, rtc12_alarm_t rtc_alarm)
RTC 12 get alarm 0 function.
uint8_t rtc12_check_int(rtc12_t *ctx)
RTC 12 check interrupt state function.
err_t rtc12_generic_write(rtc12_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
RTC 12 data writing function.
err_t rtc12_set_date(rtc12_t *ctx, rtc12_date_t rtc_date)
RTC 12 get time function.
err_t rtc12_default_cfg(rtc12_t *ctx)
RTC 12 default configuration function.
err_t rtc12_get_ctrl_reg(rtc12_t *ctx, rtc12_control_t *rtc_ctrl)
RTC 12 get control register function.
err_t rtc12_init(rtc12_t *ctx, rtc12_cfg_t *cfg)
RTC 12 initialization function.
uint8_t rtc12_check_power_fail(rtc12_t *ctx)
RTC 12 check power fail state function.
void rtc12_cfg_setup(rtc12_cfg_t *cfg)
RTC 12 configuration object setup function.
err_t rtc12_get_time(rtc12_t *ctx, rtc12_time_t *rtc_time)
RTC 12 get time function.
err_t rtc12_set_time(rtc12_t *ctx, rtc12_time_t rtc_time)
RTC 12 set time function.
err_t rtc12_get_date(rtc12_t *ctx, rtc12_date_t *rtc_date)
RTC 12 get date function.
err_t rtc12_generic_read(rtc12_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
RTC 12 data reading function.
err_t rtc12_get_alarm_0(rtc12_t *ctx, rtc12_alarm_t *rtc_alarm)
RTC 12 get alarm 0 function.
err_t rtc12_set_alarm_1(rtc12_t *ctx, rtc12_alarm_t rtc_alarm)
RTC 12 get alarm 1 function.
err_t rtc12_set_ctrl_reg(rtc12_t *ctx, rtc12_control_t rtc_ctrl)
RTC 12 set control register function.
err_t rtc12_get_alarm_1(rtc12_t *ctx, rtc12_alarm_t *rtc_alarm)
RTC 12 get alarm 1 function.
rtc12_return_value_t
RTC 12 Click return value data.
Definition: rtc12.h:245
@ RTC12_ERROR
Definition: rtc12.h:247
@ RTC12_OK
Definition: rtc12.h:246
RTC 12 Click alarm object.
Definition: rtc12.h:214
uint8_t hours
Definition: rtc12.h:216
uint8_t alarm_rate
Definition: rtc12.h:219
uint8_t day
Definition: rtc12.h:215
uint8_t min
Definition: rtc12.h:217
uint8_t sec
Definition: rtc12.h:218
RTC 12 Click configuration object.
Definition: rtc12.h:162
spi_master_chip_select_polarity_t cs_polarity
Definition: rtc12.h:179
pin_name_t sck
Definition: rtc12.h:167
spi_master_mode_t spi_mode
Definition: rtc12.h:178
pin_name_t mosi
Definition: rtc12.h:166
uint32_t spi_speed
Definition: rtc12.h:177
pin_name_t pf
Definition: rtc12.h:172
pin_name_t int_pin
Definition: rtc12.h:173
pin_name_t miso
Definition: rtc12.h:165
pin_name_t cs
Definition: rtc12.h:168
RTC 12 Click control object.
Definition: rtc12.h:228
uint8_t egfil
Definition: rtc12.h:231
uint8_t eosc
Definition: rtc12.h:229
uint8_t intcn
Definition: rtc12.h:233
uint8_t a1ie
Definition: rtc12.h:234
uint8_t a0ie
Definition: rtc12.h:235
uint8_t sqw
Definition: rtc12.h:232
uint8_t dosf
Definition: rtc12.h:230
RTC 12 Click date object.
Definition: rtc12.h:200
uint8_t month
Definition: rtc12.h:202
uint8_t day
Definition: rtc12.h:203
uint8_t year
Definition: rtc12.h:201
uint8_t day_of_week
Definition: rtc12.h:204
RTC 12 Click context object.
Definition: rtc12.h:143
spi_master_t spi
Definition: rtc12.h:151
digital_in_t pf
Definition: rtc12.h:146
digital_in_t int_pin
Definition: rtc12.h:147
pin_name_t chip_select
Definition: rtc12.h:153
RTC 12 Click time object.
Definition: rtc12.h:188
uint8_t hours
Definition: rtc12.h:189
uint8_t min
Definition: rtc12.h:190
uint8_t sec
Definition: rtc12.h:191