-
Notifications
You must be signed in to change notification settings - Fork 38
/
hal_ll_rtc.h
152 lines (138 loc) · 5.29 KB
/
hal_ll_rtc.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/****************************************************************************
**
** Copyright (C) ${COPYRIGHT_YEAR} MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** This file is part of the mikroSDK package
**
** Commercial License Usage
**
** Licensees holding valid commercial NECTO compilers AI licenses may use this
** file in accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The MikroElektronika Company.
** For licensing terms and conditions see
** https://www.mikroe.com/legal/software-license-agreement.
** For further information use the contact form at
** https://www.mikroe.com/contact.
**
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used for
** non-commercial projects under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** OF MERCHANTABILITY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
** TO THE WARRANTIES FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
** OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
**
****************************************************************************/
/*!
* @file hal_ll_rtc.h
* @brief API for RTC HAL LOW level layer.
*/
#ifndef _HAL_LL_RTC_H
#define _HAL_LL_RTC_H
#ifdef __cplusplus
extern "C"{
#endif
#ifdef __GNUC__
#include "mcu.h"
#endif
#include "hal_target.h"
#include "hal_ll_bit_control.h"
/**
* @brief Structure representing the RTC time.
* @details This structure is used to hold the real-time clock information, including
* hour, minute, second and it follows a 24-hour format.
* @note Take into consideration that any value can be changed explicitly by the user.
*/
typedef struct
{
uint8_t hour; // 2-digit format - supports values from 00 to 23
uint8_t minute; // 2-digit format - supports values from 00 to 59
uint8_t second; // 2-digit format - supports values from 00 to 59
} hal_ll_rtc_time_t;
/**
* @brief Initialize the RTC module.
* @details Initialize the RTC module.
* @param None.
*/
void hal_ll_rtc_init();
/**
* @brief Start the RTC module.
* @details Continue the RTC module count from the stored value in the count register.
* @param None.
* @return The function can return one of the values defined by
* hal_ll_rtc_err_t structure, which is size dependant on the architecture.
* @note It is recommended to check return value for error.
* @pre Before calling this function, the user is expected
* to have initialized RTC by using hal_ll_rtc_init() and have the RTC not counting.
*/
err_t hal_ll_rtc_start();
/**
* @brief Stop the RTC module.
* @details Stop the RTC module count.
* @param None.
* @return The function can return one of the values defined by
* hal_ll_rtc_err_t structure, which is size dependant on the architecture.
* @note It is recommended to check return value for error.
* @pre Before calling this function, the user is expected
* to have the RTC started.
*/
err_t hal_ll_rtc_stop();
/**
* @brief Reset the RTC module.
* @details Reset the RTC counter to the default values of 0h:0m:0s.
* @param None.
* @return The function can return one of the values defined by
* hal_ll_rtc_err_t structure, which is size dependant on the architecture.
* @note It is recommended to check return value for error.
* @pre Before calling this function, the user is expected
* to have the RTC started.
*/
err_t hal_ll_rtc_reset();
/**
* @brief Configure time of RTC module.
* @details Configure time registers with the values from hal_ll_rtc_time_t structure.
* @param time hal_ll_rtc_time_t structure.
* @return The function can return one of the values defined by
* hal_ll_rtc_err_t structure, which is size dependant on the architecture.
* @note It is recommended to check return value for error.
* @pre Before calling this function, the user is expected
* to have the RTC enabled.
*/
err_t hal_ll_rtc_set_time( hal_ll_rtc_time_t *time );
/**
* @brief Get time from RTC module.
* @details Configure hal_ll_rtc_time_t structure with the values from time registers.
* @param time hal_ll_rtc_time_t structure.
* @return The function can return one of the values defined by
* hal_ll_rtc_err_t structure, which is size dependant on the architecture.
* @note It is recommended to check return value for error.
* @pre Before calling this function, the user is expected
* to have the RTC enabled.
*/
err_t hal_ll_rtc_get_time( hal_ll_rtc_time_t *time );
/**
* @brief Preforms system reset.
* @details Resets the core and all on-chip peripherals except the Debug
* interface.
* @param None.
* @warning System reset affects core and periferals,
* depending on the architecture you will need to reconfigure opened modules.
*/
void hal_ll_rtc_system_reset();
#ifdef __cplusplus
}
#endif
#endif // HAL_LL_RTC_H