rtc13  2.0.0.0
rtc13.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 RTC13_H
29 #define RTC13_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_spi_master.h"
52 #include "spi_specifics.h"
53 
74 #define RTC13_REG_CTRL1_ADDR 0x00
75 #define RTC13_REG_CTRL2_ADDR 0x01
76 #define RTC13_REG_TIME_SECONDS 0x02
77 #define RTC13_REG_TIME_MINUTES 0x03
78 #define RTC13_REG_TIME_HOUR 0x04
79 #define RTC13_REG_DATE_DAY 0x05
80 #define RTC13_REG_DATE_WEEKDAYS 0x06
81 #define RTC13_REG_DATE_MONTHS 0x07
82 #define RTC13_REG_DATE_YEARS 0x08
83 #define RTC13_REG_ALARM_MINUTE 0x09
84 #define RTC13_REG_ALARM_HOUR 0x0A
85 #define RTC13_REG_ALARM_DAY 0x0B
86 #define RTC13_REG_ALARM_WEEKDAY 0x0C
87 #define RTC13_REG_OFFSET_ADDR 0x0D
88 #define RTC13_REG_TIMER_CLKOUT_ADDR 0x0E
89 #define RTC13_REG_COUNTDOWN_TIMER_ADDR 0x0F
90  // rtc13_reg
92 
107 #define RTC13_SOFT_RESET 0x58
108 #define RTC13_BLOCK_CLKOUT_DISABLE 0x00
109 #define RTC13_BLOCK_CLKOUT_ENABLE 0x01
110 
119 #define RTC13_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
120 #define RTC13_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
121  // rtc13_set
123 
138 #define RTC13_MAP_MIKROBUS( cfg, mikrobus ) \
139  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
140  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
141  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
142  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
143  cfg.cle = MIKROBUS( mikrobus, MIKROBUS_RST ); \
144  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
145  // rtc13_map // rtc13
148 
153 typedef struct
154 {
155  uint8_t hours;
156  uint8_t min;
157  uint8_t sec;
158 
159 } rtc13_time_t;
160 
165 typedef struct
166 {
167  uint8_t year;
168  uint8_t month;
169  uint8_t day;
170  uint8_t weekday;
171 
172 } rtc13_date_t;
173 
178 typedef struct
179 {
180  uint8_t min;
181  uint8_t hours;
182  uint8_t day;
183  uint8_t weekday;
184 
185 } rtc13_alarm_t;
186 
191 typedef struct
192 {
193  // Output pins
194  digital_out_t cle;
196  // Input pins
197  digital_in_t int_pin;
199  // Modules
200  spi_master_t spi;
202  pin_name_t chip_select;
204 } rtc13_t;
205 
210 typedef struct
211 {
212  // Communication gpio pins
213  pin_name_t miso;
214  pin_name_t mosi;
215  pin_name_t sck;
216  pin_name_t cs;
218  // Additional gpio pins
219  pin_name_t cle;
220  pin_name_t int_pin;
222  // static variable
223  uint32_t spi_speed;
224  spi_master_mode_t spi_mode;
225  spi_master_chip_select_polarity_t cs_polarity;
227 } rtc13_cfg_t;
228 
233 typedef enum
234 {
235  RTC13_OK = 0,
236  RTC13_ERROR = -1
237 
239 
258 
275 err_t rtc13_init ( rtc13_t *ctx, rtc13_cfg_t *cfg );
276 
292 err_t rtc13_default_cfg ( rtc13_t *ctx );
293 
308 uint8_t rtc13_get_interrupt ( rtc13_t *ctx );
309 
327 err_t rtc13_block_clkout ( rtc13_t *ctx, uint8_t en_clkout );
328 
346 err_t rtc13_generic_write ( rtc13_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
347 
365 err_t rtc13_generic_read ( rtc13_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
366 
382 err_t rtc13_soft_reset ( rtc13_t *ctx );
383 
400 err_t rtc13_get_time ( rtc13_t *ctx, rtc13_time_t *rtc_time );
401 
418 err_t rtc13_set_time ( rtc13_t *ctx, rtc13_time_t rtc_time );
419 
436 err_t rtc13_get_date ( rtc13_t *ctx, rtc13_date_t *rtc_date );
437 
454 err_t rtc13_set_date ( rtc13_t *ctx, rtc13_date_t rtc_date );
455 
472 err_t rtc13_get_alarm ( rtc13_t *ctx, rtc13_alarm_t *rtc_alarm );
473 
490 err_t rtc13_set_alarm ( rtc13_t *ctx, rtc13_alarm_t rtc_alarm );
491 
492 #ifdef __cplusplus
493 }
494 #endif
495 #endif // RTC13_H
496  // rtc13
498 
499 // ------------------------------------------------------------------------ END
rtc13_cfg_setup
void rtc13_cfg_setup(rtc13_cfg_t *cfg)
RTC 13 configuration object setup function.
rtc13_t::int_pin
digital_in_t int_pin
Definition: rtc13.h:197
rtc13_alarm_t
RTC 13 Click alarm object.
Definition: rtc13.h:179
rtc13_t::cle
digital_out_t cle
Definition: rtc13.h:194
rtc13_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rtc13.h:225
RTC13_ERROR
@ RTC13_ERROR
Definition: rtc13.h:236
rtc13_get_interrupt
uint8_t rtc13_get_interrupt(rtc13_t *ctx)
RTC 13 get interrupt function.
rtc13_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rtc13.h:224
rtc13_cfg_t::mosi
pin_name_t mosi
Definition: rtc13.h:214
rtc13_time_t::min
uint8_t min
Definition: rtc13.h:156
rtc13_time_t::hours
uint8_t hours
Definition: rtc13.h:155
spi_specifics.h
This file contains SPI specific macros, functions, etc.
rtc13_soft_reset
err_t rtc13_soft_reset(rtc13_t *ctx)
RTC 13 soft reset function.
rtc13_time_t
RTC 13 Click time object.
Definition: rtc13.h:154
rtc13_cfg_t::int_pin
pin_name_t int_pin
Definition: rtc13.h:220
rtc13_get_time
err_t rtc13_get_time(rtc13_t *ctx, rtc13_time_t *rtc_time)
RTC 13 get time function.
rtc13_cfg_t::cle
pin_name_t cle
Definition: rtc13.h:219
rtc13_set_time
err_t rtc13_set_time(rtc13_t *ctx, rtc13_time_t rtc_time)
RTC 13 set time function.
rtc13_generic_write
err_t rtc13_generic_write(rtc13_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
RTC 13 data writing function.
rtc13_date_t
RTC 13 Click date object.
Definition: rtc13.h:166
rtc13_t::chip_select
pin_name_t chip_select
Definition: rtc13.h:202
rtc13_cfg_t::sck
pin_name_t sck
Definition: rtc13.h:215
rtc13_alarm_t::min
uint8_t min
Definition: rtc13.h:180
rtc13_time_t::sec
uint8_t sec
Definition: rtc13.h:157
rtc13_date_t::weekday
uint8_t weekday
Definition: rtc13.h:170
rtc13_cfg_t::spi_speed
uint32_t spi_speed
Definition: rtc13.h:223
rtc13_t::spi
spi_master_t spi
Definition: rtc13.h:200
rtc13_alarm_t::weekday
uint8_t weekday
Definition: rtc13.h:183
rtc13_block_clkout
err_t rtc13_block_clkout(rtc13_t *ctx, uint8_t en_clkout)
RTC 13 block CLKOUT function.
rtc13_cfg_t
RTC 13 Click configuration object.
Definition: rtc13.h:211
rtc13_set_date
err_t rtc13_set_date(rtc13_t *ctx, rtc13_date_t rtc_date)
RTC 13 set date function.
rtc13_cfg_t::cs
pin_name_t cs
Definition: rtc13.h:216
rtc13_alarm_t::hours
uint8_t hours
Definition: rtc13.h:181
rtc13_t
RTC 13 Click context object.
Definition: rtc13.h:192
rtc13_cfg_t::miso
pin_name_t miso
Definition: rtc13.h:213
rtc13_alarm_t::day
uint8_t day
Definition: rtc13.h:182
rtc13_return_value_t
rtc13_return_value_t
RTC 13 Click return value data.
Definition: rtc13.h:234
rtc13_set_alarm
err_t rtc13_set_alarm(rtc13_t *ctx, rtc13_alarm_t rtc_alarm)
RTC 13 set alarm function.
rtc13_date_t::year
uint8_t year
Definition: rtc13.h:167
rtc13_get_date
err_t rtc13_get_date(rtc13_t *ctx, rtc13_date_t *rtc_date)
RTC 13 get date function.
rtc13_init
err_t rtc13_init(rtc13_t *ctx, rtc13_cfg_t *cfg)
RTC 13 initialization function.
rtc13_date_t::day
uint8_t day
Definition: rtc13.h:169
rtc13_date_t::month
uint8_t month
Definition: rtc13.h:168
rtc13_get_alarm
err_t rtc13_get_alarm(rtc13_t *ctx, rtc13_alarm_t *rtc_alarm)
RTC 13 get alarm function.
RTC13_OK
@ RTC13_OK
Definition: rtc13.h:235
rtc13_default_cfg
err_t rtc13_default_cfg(rtc13_t *ctx)
RTC 13 default configuration function.
rtc13_generic_read
err_t rtc13_generic_read(rtc13_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
RTC 13 data reading function.