blob: 22f6d37059178ba4c9ee057900c289f2942aa803 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenka6840a62001-04-09 21:43:07 +00002/*
3 * (C) Copyright 2001
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenka6840a62001-04-09 21:43:07 +00005 */
6
7/*
8 * Generic RTC interface.
9 */
10#ifndef _RTC_H_
11#define _RTC_H_
12
Albin Tonnerre885fc782009-08-13 15:31:12 +020013/* bcd<->bin functions are needed by almost all the RTC drivers, let's include
14 * it there instead of in evey single driver */
15
16#include <bcd.h>
Simon Glassaac51192015-04-20 12:37:21 -060017#include <rtc_def.h>
Sean Anderson640aecb2022-11-22 12:54:52 -050018#include <linux/errno.h>
Tom Rini1e8ce112023-12-14 13:16:57 -050019#include <linux/types.h>
wdenka6840a62001-04-09 21:43:07 +000020
Jan Kiszka90c52422022-04-24 11:34:56 +020021typedef int64_t time64_t;
AKASHI Takahiro09030e02019-11-13 09:44:48 +090022struct udevice;
23
Sean Anderson640aecb2022-11-22 12:54:52 -050024#if CONFIG_IS_ENABLED(DM_RTC)
Simon Glassdbeda5b2015-04-20 12:37:23 -060025struct rtc_ops {
26 /**
27 * get() - get the current time
28 *
29 * Returns the current time read from the RTC device. The driver
30 * is responsible for setting up every field in the structure.
31 *
32 * @dev: Device to read from
33 * @time: Place to put the time that is read
34 */
35 int (*get)(struct udevice *dev, struct rtc_time *time);
36
37 /**
38 * set() - set the current time
39 *
40 * Sets the time in the RTC device. The driver can expect every
41 * field to be set correctly.
42 *
43 * @dev: Device to read from
44 * @time: Time to write
45 */
46 int (*set)(struct udevice *dev, const struct rtc_time *time);
47
48 /**
49 * reset() - reset the RTC to a known-good state
50 *
51 * This function resets the RTC to a known-good state. The time may
52 * be unset by this method, so should be set after this method is
53 * called.
54 *
55 * @dev: Device to read from
56 * @return 0 if OK, -ve on error
57 */
58 int (*reset)(struct udevice *dev);
59
60 /**
Rasmus Villemoesd8be0882020-07-06 22:01:10 +020061 * read() - Read multiple 8-bit registers
62 *
63 * @dev: Device to read from
64 * @reg: First register to read
65 * @buf: Output buffer
66 * @len: Number of registers to read
67 * @return 0 if OK, -ve on error
68 */
69 int (*read)(struct udevice *dev, unsigned int reg,
70 u8 *buf, unsigned int len);
71
72 /**
Rasmus Villemoes09381822020-07-06 22:01:11 +020073 * write() - Write multiple 8-bit registers
74 *
75 * @dev: Device to write to
76 * @reg: First register to write
77 * @buf: Input buffer
78 * @len: Number of registers to write
79 * @return 0 if OK, -ve on error
80 */
81 int (*write)(struct udevice *dev, unsigned int reg,
82 const u8 *buf, unsigned int len);
83
84 /**
Simon Glassdbeda5b2015-04-20 12:37:23 -060085 * read8() - Read an 8-bit register
86 *
87 * @dev: Device to read from
88 * @reg: Register to read
89 * @return value read, or -ve on error
90 */
91 int (*read8)(struct udevice *dev, unsigned int reg);
92
93 /**
94 * write8() - Write an 8-bit register
95 *
96 * @dev: Device to write to
97 * @reg: Register to write
98 * @value: Value to write
Heinrich Schuchardt185f8122022-01-19 18:05:50 +010099 * Return: 0 if OK, -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600100 */
101 int (*write8)(struct udevice *dev, unsigned int reg, int val);
102};
103
104/* Access the operations for an RTC device */
105#define rtc_get_ops(dev) ((struct rtc_ops *)(dev)->driver->ops)
106
107/**
108 * dm_rtc_get() - Read the time from an RTC
109 *
110 * @dev: Device to read from
111 * @time: Place to put the current time
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100112 * Return: 0 if OK, -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600113 */
114int dm_rtc_get(struct udevice *dev, struct rtc_time *time);
115
116/**
Philipp Tomsicha4b33c52018-11-25 19:32:54 +0100117 * dm_rtc_set() - Write a time to an RTC
Simon Glassdbeda5b2015-04-20 12:37:23 -0600118 *
119 * @dev: Device to read from
120 * @time: Time to write into the RTC
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100121 * Return: 0 if OK, -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600122 */
123int dm_rtc_set(struct udevice *dev, struct rtc_time *time);
124
125/**
126 * dm_rtc_reset() - reset the RTC to a known-good state
127 *
128 * If the RTC appears to be broken (e.g. it is not counting up in seconds)
129 * it may need to be reset to a known good state. This function achieves this.
130 * After resetting the RTC the time should then be set to a known value by
131 * the caller.
132 *
133 * @dev: Device to read from
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100134 * Return: 0 if OK, -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600135 */
136int dm_rtc_reset(struct udevice *dev);
137
138/**
Rasmus Villemoesd8be0882020-07-06 22:01:10 +0200139 * dm_rtc_read() - Read multiple 8-bit registers
140 *
141 * @dev: Device to read from
142 * @reg: First register to read
143 * @buf: Output buffer
144 * @len: Number of registers to read
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100145 * Return: 0 if OK, -ve on error
Rasmus Villemoesd8be0882020-07-06 22:01:10 +0200146 */
147int dm_rtc_read(struct udevice *dev, unsigned int reg, u8 *buf, unsigned int len);
148
149/**
Rasmus Villemoes09381822020-07-06 22:01:11 +0200150 * dm_rtc_write() - Write multiple 8-bit registers
151 *
152 * @dev: Device to write to
153 * @reg: First register to write
154 * @buf: Input buffer
155 * @len: Number of registers to write
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100156 * Return: 0 if OK, -ve on error
Rasmus Villemoes09381822020-07-06 22:01:11 +0200157 */
158int dm_rtc_write(struct udevice *dev, unsigned int reg,
159 const u8 *buf, unsigned int len);
160
161/**
Simon Glassdbeda5b2015-04-20 12:37:23 -0600162 * rtc_read8() - Read an 8-bit register
163 *
164 * @dev: Device to read from
165 * @reg: Register to read
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100166 * Return: value read, or -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600167 */
168int rtc_read8(struct udevice *dev, unsigned int reg);
169
170/**
171 * rtc_write8() - Write an 8-bit register
172 *
173 * @dev: Device to write to
174 * @reg: Register to write
175 * @value: Value to write
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100176 * Return: 0 if OK, -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600177 */
178int rtc_write8(struct udevice *dev, unsigned int reg, int val);
179
180/**
Bin Mengd24c7fb2017-03-16 07:26:27 -0700181 * rtc_read16() - Read a 16-bit value from the RTC
182 *
183 * @dev: Device to read from
184 * @reg: Offset to start reading from
185 * @valuep: Place to put the value that is read
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100186 * Return: 0 if OK, -ve on error
Bin Mengd24c7fb2017-03-16 07:26:27 -0700187 */
188int rtc_read16(struct udevice *dev, unsigned int reg, u16 *valuep);
189
190/**
191 * rtc_write16() - Write a 16-bit value to the RTC
192 *
193 * @dev: Device to write to
194 * @reg: Register to start writing to
195 * @value: Value to write
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100196 * Return: 0 if OK, -ve on error
Bin Mengd24c7fb2017-03-16 07:26:27 -0700197 */
198int rtc_write16(struct udevice *dev, unsigned int reg, u16 value);
199
200/**
Simon Glassdbeda5b2015-04-20 12:37:23 -0600201 * rtc_read32() - Read a 32-bit value from the RTC
202 *
203 * @dev: Device to read from
204 * @reg: Offset to start reading from
205 * @valuep: Place to put the value that is read
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100206 * Return: 0 if OK, -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600207 */
208int rtc_read32(struct udevice *dev, unsigned int reg, u32 *valuep);
209
210/**
211 * rtc_write32() - Write a 32-bit value to the RTC
212 *
213 * @dev: Device to write to
214 * @reg: Register to start writing to
215 * @value: Value to write
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100216 * Return: 0 if OK, -ve on error
Simon Glassdbeda5b2015-04-20 12:37:23 -0600217 */
218int rtc_write32(struct udevice *dev, unsigned int reg, u32 value);
219
Chuanhua Handb07c442019-07-26 19:24:00 +0800220#ifdef CONFIG_RTC_ENABLE_32KHZ_OUTPUT
221int rtc_enable_32khz_output(int busnum, int chip_addr);
222#endif
223
Simon Glassdbeda5b2015-04-20 12:37:23 -0600224#else
Sean Anderson640aecb2022-11-22 12:54:52 -0500225static inline int dm_rtc_get(struct udevice *dev, struct rtc_time *time)
226{
227 return -ENOSYS;
228}
229
230static inline int dm_rtc_set(struct udevice *dev, struct rtc_time *time)
231{
232 return -ENOSYS;
233}
234
235static inline int dm_rtc_reset(struct udevice *dev)
236{
237 return -ENOSYS;
238}
239
240static inline int dm_rtc_read(struct udevice *dev, unsigned int reg, u8 *buf,
241 unsigned int len)
242{
243 return -ENOSYS;
244}
245
246static inline int dm_rtc_write(struct udevice *dev, unsigned int reg,
247 const u8 *buf, unsigned int len)
248{
249 return -ENOSYS;
250}
251
Yuri Tikhonovb73a19e2008-03-20 17:56:04 +0300252int rtc_get (struct rtc_time *);
Jean-Christophe PLAGNIOL-VILLARDd1e23192008-09-01 23:06:23 +0200253int rtc_set (struct rtc_time *);
wdenka6840a62001-04-09 21:43:07 +0000254void rtc_reset (void);
Chuanhua Handb07c442019-07-26 19:24:00 +0800255#ifdef CONFIG_RTC_ENABLE_32KHZ_OUTPUT
Priyanka Jainc3409412015-06-29 15:39:23 +0530256void rtc_enable_32khz_output(void);
Chuanhua Handb07c442019-07-26 19:24:00 +0800257#endif
wdenka6840a62001-04-09 21:43:07 +0000258
Simon Glassc6577f72014-11-14 18:18:26 -0700259/**
Simon Glassfc4860c2015-01-19 22:16:10 -0700260 * rtc_read8() - Read an 8-bit register
261 *
262 * @reg: Register to read
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100263 * Return: value read
Simon Glassfc4860c2015-01-19 22:16:10 -0700264 */
265int rtc_read8(int reg);
266
267/**
268 * rtc_write8() - Write an 8-bit register
269 *
270 * @reg: Register to write
271 * @value: Value to write
272 */
273void rtc_write8(int reg, uchar val);
274
275/**
276 * rtc_read32() - Read a 32-bit value from the RTC
277 *
278 * @reg: Offset to start reading from
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100279 * Return: value read
Simon Glassfc4860c2015-01-19 22:16:10 -0700280 */
281u32 rtc_read32(int reg);
282
283/**
284 * rtc_write32() - Write a 32-bit value to the RTC
285 *
286 * @reg: Register to start writing to
287 * @value: Value to write
288 */
289void rtc_write32(int reg, u32 value);
290
291/**
Simon Glassc6577f72014-11-14 18:18:26 -0700292 * rtc_init() - Set up the real time clock ready for use
293 */
294void rtc_init(void);
Heinrich Schuchardt992c1db2018-07-07 23:39:11 +0200295#endif /* CONFIG_DM_RTC */
296
297/**
298 * is_leap_year - Check if year is a leap year
299 *
300 * @year Year
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100301 * Return: 1 if leap year
Heinrich Schuchardt992c1db2018-07-07 23:39:11 +0200302 */
303static inline bool is_leap_year(unsigned int year)
304{
305 return (!(year % 4) && (year % 100)) || !(year % 400);
306}
Simon Glassc6577f72014-11-14 18:18:26 -0700307
Simon Glass199e87c2015-04-20 12:37:17 -0600308/**
309 * rtc_calc_weekday() - Work out the weekday from a time
310 *
311 * This only works for the Gregorian calendar - i.e. after 1752 (in the UK).
312 * It sets time->tm_wdaay to the correct day of the week.
313 *
314 * @time: Time to inspect. tm_wday is updated
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100315 * Return: 0 if OK, -EINVAL if the weekday could not be determined
Simon Glass199e87c2015-04-20 12:37:17 -0600316 */
317int rtc_calc_weekday(struct rtc_time *time);
318
Simon Glass9f9276c2015-04-20 12:37:18 -0600319/**
320 * rtc_to_tm() - Convert a time_t value into a broken-out time
321 *
322 * The following fields are set up by this function:
323 * tm_sec, tm_min, tm_hour, tm_mday, tm_mon, tm_year, tm_wday
324 *
325 * Note that tm_yday and tm_isdst are set to 0.
326 *
327 * @time_t: Number of seconds since 1970-01-01 00:00:00
328 * @time: Place to put the broken-out time
Simon Glass9f9276c2015-04-20 12:37:18 -0600329 */
Heinrich Schuchardt992c1db2018-07-07 23:39:11 +0200330void rtc_to_tm(u64 time_t, struct rtc_time *time);
Simon Glass9f9276c2015-04-20 12:37:18 -0600331
Simon Glass71420982015-04-20 12:37:19 -0600332/**
Jan Kiszka90c52422022-04-24 11:34:56 +0200333 * rtc_mktime() - Convert a broken-out time into a time64_t value
Simon Glass71420982015-04-20 12:37:19 -0600334 *
335 * The following fields need to be valid for this function to work:
336 * tm_sec, tm_min, tm_hour, tm_mday, tm_mon, tm_year
337 *
338 * Note that tm_wday and tm_yday are ignored.
339 *
340 * @time: Broken-out time to convert
Jan Kiszka90c52422022-04-24 11:34:56 +0200341 * Return: corresponding time64_t value, seconds since 1970-01-01 00:00:00
Simon Glass71420982015-04-20 12:37:19 -0600342 */
Jan Kiszka90c52422022-04-24 11:34:56 +0200343time64_t rtc_mktime(const struct rtc_time *time);
Simon Glass71420982015-04-20 12:37:19 -0600344
Heinrich Schuchardt3c1889e2019-05-31 07:21:03 +0200345/**
346 * rtc_month_days() - The number of days in the month
347 *
348 * @month: month (January = 0)
349 * @year: year (4 digits)
350 */
351int rtc_month_days(unsigned int month, unsigned int year);
352
wdenka6840a62001-04-09 21:43:07 +0000353#endif /* _RTC_H_ */