libnvdimm/altmap: Track namespace boundaries in altmap
[linux-2.6-block.git] / drivers / rtc / sysfs.c
CommitLineData
cdf7545a 1// SPDX-License-Identifier: GPL-2.0
c5c3e192
AZ
2/*
3 * RTC subsystem, sysfs interface
4 *
5 * Copyright (C) 2005 Tower Technologies
6 * Author: Alessandro Zummo <a.zummo@towertech.it>
cdf7545a 7 */
c5c3e192
AZ
8
9#include <linux/module.h>
10#include <linux/rtc.h>
11
ab6a2d70
DB
12#include "rtc-core.h"
13
c5c3e192
AZ
14/* device attributes */
15
8a0bdfd7
DB
16/*
17 * NOTE: RTC times displayed in sysfs use the RTC's timezone. That's
18 * ideally UTC. However, PCs that also boot to MS-Windows normally use
19 * the local time and change to match daylight savings time. That affects
20 * attributes including date, time, since_epoch, and wakealarm.
21 */
22
cd966209 23static ssize_t
f21e6835 24name_show(struct device *dev, struct device_attribute *attr, char *buf)
c5c3e192 25{
77a73f3c
AB
26 return sprintf(buf, "%s %s\n", dev_driver_string(dev->parent),
27 dev_name(dev->parent));
c5c3e192 28}
f21e6835 29static DEVICE_ATTR_RO(name);
c5c3e192 30
cd966209 31static ssize_t
f21e6835 32date_show(struct device *dev, struct device_attribute *attr, char *buf)
c5c3e192
AZ
33{
34 ssize_t retval;
35 struct rtc_time tm;
36
ab6a2d70 37 retval = rtc_read_time(to_rtc_device(dev), &tm);
5548cbf7
AS
38 if (retval)
39 return retval;
c5c3e192 40
5548cbf7 41 return sprintf(buf, "%ptRd\n", &tm);
c5c3e192 42}
f21e6835 43static DEVICE_ATTR_RO(date);
c5c3e192 44
cd966209 45static ssize_t
f21e6835 46time_show(struct device *dev, struct device_attribute *attr, char *buf)
c5c3e192
AZ
47{
48 ssize_t retval;
49 struct rtc_time tm;
50
ab6a2d70 51 retval = rtc_read_time(to_rtc_device(dev), &tm);
5548cbf7
AS
52 if (retval)
53 return retval;
c5c3e192 54
5548cbf7 55 return sprintf(buf, "%ptRt\n", &tm);
c5c3e192 56}
f21e6835 57static DEVICE_ATTR_RO(time);
c5c3e192 58
cd966209 59static ssize_t
f21e6835 60since_epoch_show(struct device *dev, struct device_attribute *attr, char *buf)
c5c3e192
AZ
61{
62 ssize_t retval;
63 struct rtc_time tm;
64
ab6a2d70 65 retval = rtc_read_time(to_rtc_device(dev), &tm);
c5c3e192 66 if (retval == 0) {
9a06da2e
BW
67 time64_t time;
68
69 time = rtc_tm_to_time64(&tm);
70 retval = sprintf(buf, "%lld\n", time);
c5c3e192
AZ
71 }
72
73 return retval;
74}
f21e6835 75static DEVICE_ATTR_RO(since_epoch);
c5c3e192 76
06c65eb4 77static ssize_t
f21e6835 78max_user_freq_show(struct device *dev, struct device_attribute *attr, char *buf)
06c65eb4
BK
79{
80 return sprintf(buf, "%d\n", to_rtc_device(dev)->max_user_freq);
81}
82
83static ssize_t
f21e6835 84max_user_freq_store(struct device *dev, struct device_attribute *attr,
606cc43c 85 const char *buf, size_t n)
06c65eb4
BK
86{
87 struct rtc_device *rtc = to_rtc_device(dev);
f571287b
LC
88 unsigned long val;
89 int err;
90
91 err = kstrtoul(buf, 0, &val);
92 if (err)
93 return err;
06c65eb4
BK
94
95 if (val >= 4096 || val == 0)
96 return -EINVAL;
97
98 rtc->max_user_freq = (int)val;
99
100 return n;
101}
f21e6835 102static DEVICE_ATTR_RW(max_user_freq);
06c65eb4 103
4c24e29e
DF
104/**
105 * rtc_sysfs_show_hctosys - indicate if the given RTC set the system time
106 *
107 * Returns 1 if the system clock was set by this RTC at the last
108 * boot or resume event.
109 */
d8c1acb1 110static ssize_t
f21e6835 111hctosys_show(struct device *dev, struct device_attribute *attr, char *buf)
d8c1acb1
MG
112{
113#ifdef CONFIG_RTC_HCTOSYS_DEVICE
d0ab4a4d 114 if (rtc_hctosys_ret == 0 &&
606cc43c
AB
115 strcmp(dev_name(&to_rtc_device(dev)->dev),
116 CONFIG_RTC_HCTOSYS_DEVICE) == 0)
d8c1acb1 117 return sprintf(buf, "1\n");
d8c1acb1 118#endif
606cc43c 119 return sprintf(buf, "0\n");
d8c1acb1 120}
f21e6835
GKH
121static DEVICE_ATTR_RO(hctosys);
122
3925a5ce 123static ssize_t
a17ccd1c 124wakealarm_show(struct device *dev, struct device_attribute *attr, char *buf)
3925a5ce
DB
125{
126 ssize_t retval;
9a06da2e 127 time64_t alarm;
3925a5ce
DB
128 struct rtc_wkalrm alm;
129
8a0bdfd7
DB
130 /* Don't show disabled alarms. For uniformity, RTC alarms are
131 * conceptually one-shot, even though some common RTCs (on PCs)
132 * don't actually work that way.
3925a5ce 133 *
8a0bdfd7
DB
134 * NOTE: RTC implementations where the alarm doesn't match an
135 * exact YYYY-MM-DD HH:MM[:SS] date *must* disable their RTC
136 * alarms after they trigger, to ensure one-shot semantics.
3925a5ce 137 */
ab6a2d70 138 retval = rtc_read_alarm(to_rtc_device(dev), &alm);
3925a5ce 139 if (retval == 0 && alm.enabled) {
9a06da2e
BW
140 alarm = rtc_tm_to_time64(&alm.time);
141 retval = sprintf(buf, "%lld\n", alarm);
3925a5ce
DB
142 }
143
144 return retval;
145}
146
147static ssize_t
a17ccd1c 148wakealarm_store(struct device *dev, struct device_attribute *attr,
cd966209 149 const char *buf, size_t n)
3925a5ce
DB
150{
151 ssize_t retval;
9a06da2e
BW
152 time64_t now, alarm;
153 time64_t push = 0;
3925a5ce 154 struct rtc_wkalrm alm;
ab6a2d70 155 struct rtc_device *rtc = to_rtc_device(dev);
84281c2d 156 const char *buf_ptr;
c116bc2a 157 int adjust = 0;
3925a5ce
DB
158
159 /* Only request alarms that trigger in the future. Disable them
160 * by writing another time, e.g. 0 meaning Jan 1 1970 UTC.
161 */
ab6a2d70 162 retval = rtc_read_time(rtc, &alm.time);
3925a5ce
DB
163 if (retval < 0)
164 return retval;
9a06da2e 165 now = rtc_tm_to_time64(&alm.time);
3925a5ce 166
84281c2d 167 buf_ptr = buf;
c116bc2a
ZY
168 if (*buf_ptr == '+') {
169 buf_ptr++;
1df0a471
BT
170 if (*buf_ptr == '=') {
171 buf_ptr++;
172 push = 1;
606cc43c 173 } else {
1df0a471 174 adjust = 1;
606cc43c 175 }
c116bc2a 176 }
9a06da2e 177 retval = kstrtos64(buf_ptr, 0, &alarm);
f571287b
LC
178 if (retval)
179 return retval;
606cc43c 180 if (adjust)
c116bc2a 181 alarm += now;
1df0a471 182 if (alarm > now || push) {
3925a5ce
DB
183 /* Avoid accidentally clobbering active alarms; we can't
184 * entirely prevent that here, without even the minimal
185 * locking from the /dev/rtcN api.
186 */
ab6a2d70 187 retval = rtc_read_alarm(rtc, &alm);
3925a5ce
DB
188 if (retval < 0)
189 return retval;
1df0a471
BT
190 if (alm.enabled) {
191 if (push) {
9a06da2e 192 push = rtc_tm_to_time64(&alm.time);
1df0a471
BT
193 alarm += push;
194 } else
195 return -EBUSY;
196 } else if (push)
197 return -EINVAL;
3925a5ce
DB
198 alm.enabled = 1;
199 } else {
200 alm.enabled = 0;
201
202 /* Provide a valid future alarm time. Linux isn't EFI,
203 * this time won't be ignored when disabling the alarm.
204 */
205 alarm = now + 300;
206 }
9a06da2e 207 rtc_time64_to_tm(alarm, &alm.time);
3925a5ce 208
ab6a2d70 209 retval = rtc_set_alarm(rtc, &alm);
3925a5ce
DB
210 return (retval < 0) ? retval : n;
211}
a17ccd1c 212static DEVICE_ATTR_RW(wakealarm);
3925a5ce 213
5495a415
JC
214static ssize_t
215offset_show(struct device *dev, struct device_attribute *attr, char *buf)
216{
217 ssize_t retval;
218 long offset;
219
220 retval = rtc_read_offset(to_rtc_device(dev), &offset);
221 if (retval == 0)
222 retval = sprintf(buf, "%ld\n", offset);
223
224 return retval;
225}
226
227static ssize_t
228offset_store(struct device *dev, struct device_attribute *attr,
229 const char *buf, size_t n)
230{
231 ssize_t retval;
232 long offset;
233
234 retval = kstrtol(buf, 10, &offset);
235 if (retval == 0)
236 retval = rtc_set_offset(to_rtc_device(dev), offset);
237
238 return (retval < 0) ? retval : n;
239}
240static DEVICE_ATTR_RW(offset);
241
71db049e
AB
242static ssize_t
243range_show(struct device *dev, struct device_attribute *attr, char *buf)
244{
245 return sprintf(buf, "[%lld,%llu]\n", to_rtc_device(dev)->range_min,
246 to_rtc_device(dev)->range_max);
247}
248static DEVICE_ATTR_RO(range);
249
3ee2c40b
DT
250static struct attribute *rtc_attrs[] = {
251 &dev_attr_name.attr,
252 &dev_attr_date.attr,
253 &dev_attr_time.attr,
254 &dev_attr_since_epoch.attr,
255 &dev_attr_max_user_freq.attr,
256 &dev_attr_hctosys.attr,
257 &dev_attr_wakealarm.attr,
5495a415 258 &dev_attr_offset.attr,
71db049e 259 &dev_attr_range.attr,
3ee2c40b
DT
260 NULL,
261};
3925a5ce
DB
262
263/* The reason to trigger an alarm with no process watching it (via sysfs)
264 * is its side effect: waking from a system state like suspend-to-RAM or
265 * suspend-to-disk. So: no attribute unless that side effect is possible.
266 * (Userspace may disable that mechanism later.)
267 */
df100c01 268static bool rtc_does_wakealarm(struct rtc_device *rtc)
3925a5ce 269{
cd966209 270 if (!device_can_wakeup(rtc->dev.parent))
df100c01
DT
271 return false;
272
3925a5ce
DB
273 return rtc->ops->set_alarm != NULL;
274}
275
3ee2c40b
DT
276static umode_t rtc_attr_is_visible(struct kobject *kobj,
277 struct attribute *attr, int n)
c5c3e192 278{
3ee2c40b
DT
279 struct device *dev = container_of(kobj, struct device, kobj);
280 struct rtc_device *rtc = to_rtc_device(dev);
281 umode_t mode = attr->mode;
c5c3e192 282
5495a415 283 if (attr == &dev_attr_wakealarm.attr) {
3ee2c40b
DT
284 if (!rtc_does_wakealarm(rtc))
285 mode = 0;
5495a415
JC
286 } else if (attr == &dev_attr_offset.attr) {
287 if (!rtc->ops->set_offset)
288 mode = 0;
71db049e
AB
289 } else if (attr == &dev_attr_range.attr) {
290 if (!(rtc->range_max - rtc->range_min))
291 mode = 0;
5495a415 292 }
c5c3e192 293
3ee2c40b 294 return mode;
c5c3e192
AZ
295}
296
3ee2c40b
DT
297static struct attribute_group rtc_attr_group = {
298 .is_visible = rtc_attr_is_visible,
299 .attrs = rtc_attrs,
300};
301
302static const struct attribute_group *rtc_attr_groups[] = {
303 &rtc_attr_group,
304 NULL
305};
c5c3e192 306
3ee2c40b 307const struct attribute_group **rtc_get_dev_attribute_groups(void)
c5c3e192 308{
3ee2c40b 309 return rtc_attr_groups;
c5c3e192 310}
a0a1a1ba
DO
311
312int rtc_add_groups(struct rtc_device *rtc, const struct attribute_group **grps)
313{
314 size_t old_cnt = 0, add_cnt = 0, new_cnt;
315 const struct attribute_group **groups, **old;
316
317 if (rtc->registered)
318 return -EINVAL;
319 if (!grps)
320 return -EINVAL;
321
322 groups = rtc->dev.groups;
323 if (groups)
324 for (; *groups; groups++)
325 old_cnt++;
326
327 for (groups = grps; *groups; groups++)
328 add_cnt++;
329
330 new_cnt = old_cnt + add_cnt + 1;
331 groups = devm_kcalloc(&rtc->dev, new_cnt, sizeof(*groups), GFP_KERNEL);
777d8ae5
DC
332 if (!groups)
333 return -ENOMEM;
a0a1a1ba
DO
334 memcpy(groups, rtc->dev.groups, old_cnt * sizeof(*groups));
335 memcpy(groups + old_cnt, grps, add_cnt * sizeof(*groups));
336 groups[old_cnt + add_cnt] = NULL;
337
338 old = rtc->dev.groups;
339 rtc->dev.groups = groups;
340 if (old && old != rtc_attr_groups)
341 devm_kfree(&rtc->dev, old);
342
343 return 0;
344}
345EXPORT_SYMBOL(rtc_add_groups);
346
347int rtc_add_group(struct rtc_device *rtc, const struct attribute_group *grp)
348{
349 const struct attribute_group *groups[] = { grp, NULL };
350
351 return rtc_add_groups(rtc, groups);
352}
353EXPORT_SYMBOL(rtc_add_group);