Blame view
include/rtc.h
6.61 KB
83d290c56
|
1 |
/* SPDX-License-Identifier: GPL-2.0+ */ |
a6840a6ed
|
2 3 4 |
/* * (C) Copyright 2001 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
a6840a6ed
|
5 6 7 8 9 10 11 |
*/ /* * Generic RTC interface. */ #ifndef _RTC_H_ #define _RTC_H_ |
885fc78c2
|
12 13 14 15 |
/* bcd<->bin functions are needed by almost all the RTC drivers, let's include * it there instead of in evey single driver */ #include <bcd.h> |
aac511982
|
16 |
#include <rtc_def.h> |
a6840a6ed
|
17 |
|
dbeda5b22
|
18 |
#ifdef CONFIG_DM_RTC |
09030e036
|
19 |
struct udevice; |
dbeda5b22
|
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 |
struct rtc_ops { /** * get() - get the current time * * Returns the current time read from the RTC device. The driver * is responsible for setting up every field in the structure. * * @dev: Device to read from * @time: Place to put the time that is read */ int (*get)(struct udevice *dev, struct rtc_time *time); /** * set() - set the current time * * Sets the time in the RTC device. The driver can expect every * field to be set correctly. * * @dev: Device to read from * @time: Time to write */ int (*set)(struct udevice *dev, const struct rtc_time *time); /** * reset() - reset the RTC to a known-good state * * This function resets the RTC to a known-good state. The time may * be unset by this method, so should be set after this method is * called. * * @dev: Device to read from * @return 0 if OK, -ve on error */ int (*reset)(struct udevice *dev); /** * read8() - Read an 8-bit register * * @dev: Device to read from * @reg: Register to read * @return value read, or -ve on error */ int (*read8)(struct udevice *dev, unsigned int reg); /** * write8() - Write an 8-bit register * * @dev: Device to write to * @reg: Register to write * @value: Value to write * @return 0 if OK, -ve on error */ int (*write8)(struct udevice *dev, unsigned int reg, int val); }; /* Access the operations for an RTC device */ #define rtc_get_ops(dev) ((struct rtc_ops *)(dev)->driver->ops) /** * dm_rtc_get() - Read the time from an RTC * * @dev: Device to read from * @time: Place to put the current time * @return 0 if OK, -ve on error */ int dm_rtc_get(struct udevice *dev, struct rtc_time *time); /** |
a4b33c5ab
|
88 |
* dm_rtc_set() - Write a time to an RTC |
dbeda5b22
|
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 |
* * @dev: Device to read from * @time: Time to write into the RTC * @return 0 if OK, -ve on error */ int dm_rtc_set(struct udevice *dev, struct rtc_time *time); /** * dm_rtc_reset() - reset the RTC to a known-good state * * If the RTC appears to be broken (e.g. it is not counting up in seconds) * it may need to be reset to a known good state. This function achieves this. * After resetting the RTC the time should then be set to a known value by * the caller. * * @dev: Device to read from * @return 0 if OK, -ve on error */ int dm_rtc_reset(struct udevice *dev); /** * rtc_read8() - Read an 8-bit register * * @dev: Device to read from * @reg: Register to read * @return value read, or -ve on error */ int rtc_read8(struct udevice *dev, unsigned int reg); /** * rtc_write8() - Write an 8-bit register * * @dev: Device to write to * @reg: Register to write * @value: Value to write * @return 0 if OK, -ve on error */ int rtc_write8(struct udevice *dev, unsigned int reg, int val); /** |
d24c7fbcc
|
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
* rtc_read16() - Read a 16-bit value from the RTC * * @dev: Device to read from * @reg: Offset to start reading from * @valuep: Place to put the value that is read * @return 0 if OK, -ve on error */ int rtc_read16(struct udevice *dev, unsigned int reg, u16 *valuep); /** * rtc_write16() - Write a 16-bit value to the RTC * * @dev: Device to write to * @reg: Register to start writing to * @value: Value to write * @return 0 if OK, -ve on error */ int rtc_write16(struct udevice *dev, unsigned int reg, u16 value); /** |
dbeda5b22
|
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
* rtc_read32() - Read a 32-bit value from the RTC * * @dev: Device to read from * @reg: Offset to start reading from * @valuep: Place to put the value that is read * @return 0 if OK, -ve on error */ int rtc_read32(struct udevice *dev, unsigned int reg, u32 *valuep); /** * rtc_write32() - Write a 32-bit value to the RTC * * @dev: Device to write to * @reg: Register to start writing to * @value: Value to write * @return 0 if OK, -ve on error */ int rtc_write32(struct udevice *dev, unsigned int reg, u32 value); |
db07c447c
|
167 168 169 |
#ifdef CONFIG_RTC_ENABLE_32KHZ_OUTPUT int rtc_enable_32khz_output(int busnum, int chip_addr); #endif |
dbeda5b22
|
170 |
#else |
b73a19e16
|
171 |
int rtc_get (struct rtc_time *); |
d1e231941
|
172 |
int rtc_set (struct rtc_time *); |
a6840a6ed
|
173 |
void rtc_reset (void); |
db07c447c
|
174 |
#ifdef CONFIG_RTC_ENABLE_32KHZ_OUTPUT |
c340941e4
|
175 |
void rtc_enable_32khz_output(void); |
db07c447c
|
176 |
#endif |
a6840a6ed
|
177 |
|
c6577f721
|
178 |
/** |
fc4860c08
|
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
* rtc_read8() - Read an 8-bit register * * @reg: Register to read * @return value read */ int rtc_read8(int reg); /** * rtc_write8() - Write an 8-bit register * * @reg: Register to write * @value: Value to write */ void rtc_write8(int reg, uchar val); /** * rtc_read32() - Read a 32-bit value from the RTC * * @reg: Offset to start reading from * @return value read */ u32 rtc_read32(int reg); /** * rtc_write32() - Write a 32-bit value to the RTC * * @reg: Register to start writing to * @value: Value to write */ void rtc_write32(int reg, u32 value); /** |
c6577f721
|
211 212 213 |
* rtc_init() - Set up the real time clock ready for use */ void rtc_init(void); |
992c1db45
|
214 215 216 217 218 219 220 221 222 223 224 225 |
#endif /* CONFIG_DM_RTC */ /** * is_leap_year - Check if year is a leap year * * @year Year * @return 1 if leap year */ static inline bool is_leap_year(unsigned int year) { return (!(year % 4) && (year % 100)) || !(year % 400); } |
c6577f721
|
226 |
|
199e87c34
|
227 228 229 230 231 232 233 234 235 236 |
/** * rtc_calc_weekday() - Work out the weekday from a time * * This only works for the Gregorian calendar - i.e. after 1752 (in the UK). * It sets time->tm_wdaay to the correct day of the week. * * @time: Time to inspect. tm_wday is updated * @return 0 if OK, -EINVAL if the weekday could not be determined */ int rtc_calc_weekday(struct rtc_time *time); |
9f9276c34
|
237 238 239 240 241 242 243 244 245 246 |
/** * rtc_to_tm() - Convert a time_t value into a broken-out time * * The following fields are set up by this function: * tm_sec, tm_min, tm_hour, tm_mday, tm_mon, tm_year, tm_wday * * Note that tm_yday and tm_isdst are set to 0. * * @time_t: Number of seconds since 1970-01-01 00:00:00 * @time: Place to put the broken-out time |
9f9276c34
|
247 |
*/ |
992c1db45
|
248 |
void rtc_to_tm(u64 time_t, struct rtc_time *time); |
9f9276c34
|
249 |
|
714209832
|
250 251 252 253 254 255 256 257 258 259 260 261 |
/** * rtc_mktime() - Convert a broken-out time into a time_t value * * The following fields need to be valid for this function to work: * tm_sec, tm_min, tm_hour, tm_mday, tm_mon, tm_year * * Note that tm_wday and tm_yday are ignored. * * @time: Broken-out time to convert * @return corresponding time_t value, seconds since 1970-01-01 00:00:00 */ unsigned long rtc_mktime(const struct rtc_time *time); |
3c1889e63
|
262 263 264 265 266 267 268 |
/** * rtc_month_days() - The number of days in the month * * @month: month (January = 0) * @year: year (4 digits) */ int rtc_month_days(unsigned int month, unsigned int year); |
a6840a6ed
|
269 |
#endif /* _RTC_H_ */ |