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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/*
* (C) Copyright 2001
* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
*
* SPDX-License-Identifier: GPL-2.0+
*/
/*
* Generic RTC interface.
*/
#ifndef _RTC_H_
#define _RTC_H_
/* 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>
#include <rtc_def.h>
#ifdef CONFIG_DM_RTC
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);
/**
* dm_rtc_put() - Write a time to an RTC
*
* @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);
/**
* 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);
#else
int rtc_get (struct rtc_time *);
int rtc_set (struct rtc_time *);
void rtc_reset (void);
/**
* 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);
/**
* rtc_init() - Set up the real time clock ready for use
*/
void rtc_init(void);
#endif
/**
* 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);
/**
* 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
* @return 0 if OK, -EINVAL if the weekday could not be determined
*/
int rtc_to_tm(int time_t, struct rtc_time *time);
/**
* 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);
#endif /* _RTC_H_ */
|
