Release 4.14 drivers/rtc/rtc-sysfs.c

/*
 * RTC subsystem, sysfs interface
 *
 * Copyright (C) 2005 Tower Technologies
 * Author: Alessandro Zummo <a.zummo@towertech.it>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
*/

#include <linux/module.h>
#include <linux/rtc.h>

#include "rtc-core.h"


/* device attributes */

/*
 * NOTE:  RTC times displayed in sysfs use the RTC's timezone.  That's
 * ideally UTC.  However, PCs that also boot to MS-Windows normally use
 * the local time and change to match daylight savings time.  That affects
 * attributes including date, time, since_epoch, and wakealarm.
 */


static ssize_t

name_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	return sprintf(buf, "%s %s\n", dev_driver_string(dev->parent),
		       dev_name(dev->parent));
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Alessandro Zummo
25
59.52%
1
25.00%
Alexandre Belloni
10
23.81%
1
25.00%
David Brownell
6
14.29%
1
25.00%
Greg Kroah-Hartman
1
2.38%
1
25.00%
Total
42
100.00%
4
100.00%

static DEVICE_ATTR_RO(name);


static ssize_t

date_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	ssize_t retval;
	struct rtc_time tm;

	retval = rtc_read_time(to_rtc_device(dev), &tm);
	if (retval == 0) {
		retval = sprintf(buf, "%04d-%02d-%02d\n",
			tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday);
	}

	return retval;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Alessandro Zummo
66
86.84%
1
25.00%
David Brownell
9
11.84%
2
50.00%
Greg Kroah-Hartman
1
1.32%
1
25.00%
Total
76
100.00%
4
100.00%

static DEVICE_ATTR_RO(date);


static ssize_t

time_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	ssize_t retval;
	struct rtc_time tm;

	retval = rtc_read_time(to_rtc_device(dev), &tm);
	if (retval == 0) {
		retval = sprintf(buf, "%02d:%02d:%02d\n",
			tm.tm_hour, tm.tm_min, tm.tm_sec);
	}

	return retval;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Alessandro Zummo
62
86.11%
1
25.00%
David Brownell
9
12.50%
2
50.00%
Greg Kroah-Hartman
1
1.39%
1
25.00%
Total
72
100.00%
4
100.00%

static DEVICE_ATTR_RO(time);


static ssize_t

since_epoch_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	ssize_t retval;
	struct rtc_time tm;

	retval = rtc_read_time(to_rtc_device(dev), &tm);
	if (retval == 0) {
		unsigned long time;
		rtc_tm_to_time(&tm, &time);
		retval = sprintf(buf, "%lu\n", time);
	}

	return retval;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Alessandro Zummo
65
86.67%
1
25.00%
David Brownell
9
12.00%
2
50.00%
Greg Kroah-Hartman
1
1.33%
1
25.00%
Total
75
100.00%
4
100.00%

static DEVICE_ATTR_RO(since_epoch);


static ssize_t

max_user_freq_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	return sprintf(buf, "%d\n", to_rtc_device(dev)->max_user_freq);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Bryan Kadzban
34
97.14%
1
50.00%
Greg Kroah-Hartman
1
2.86%
1
50.00%
Total
35
100.00%
2
100.00%


static ssize_t

max_user_freq_store(struct device *dev, struct device_attribute *attr,
		const char *buf, size_t n)
{
	struct rtc_device *rtc = to_rtc_device(dev);
	unsigned long val;
	int err;

	err = kstrtoul(buf, 0, &val);
	if (err)
		return err;

	if (val >= 4096 || val == 0)
		return -EINVAL;

	rtc->max_user_freq = (int)val;

	return n;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Bryan Kadzban
67
77.91%
1
33.33%
Corentin Labbe
18
20.93%
1
33.33%
Greg Kroah-Hartman
1
1.16%
1
33.33%
Total
86
100.00%
3
100.00%

static DEVICE_ATTR_RW(max_user_freq);

/**
 * rtc_sysfs_show_hctosys - indicate if the given RTC set the system time
 *
 * Returns 1 if the system clock was set by this RTC at the last
 * boot or resume event.
 */

static ssize_t

hctosys_show(struct device *dev, struct device_attribute *attr, char *buf)
{
#ifdef CONFIG_RTC_HCTOSYS_DEVICE
	if (rtc_hctosys_ret == 0 &&
			strcmp(dev_name(&to_rtc_device(dev)->dev),
				CONFIG_RTC_HCTOSYS_DEVICE) == 0)
		return sprintf(buf, "1\n");
	else
#endif
		return sprintf(buf, "0\n");
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Matthew Garrett
61
92.42%
1
33.33%
Uwe Kleine-König
4
6.06%
1
33.33%
Greg Kroah-Hartman
1
1.52%
1
33.33%
Total
66
100.00%
3
100.00%

static DEVICE_ATTR_RO(hctosys);


static ssize_t

wakealarm_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	ssize_t retval;
	unsigned long alarm;
	struct rtc_wkalrm alm;

	/* Don't show disabled alarms.  For uniformity, RTC alarms are
         * conceptually one-shot, even though some common RTCs (on PCs)
         * don't actually work that way.
         *
         * NOTE: RTC implementations where the alarm doesn't match an
         * exact YYYY-MM-DD HH:MM[:SS] date *must* disable their RTC
         * alarms after they trigger, to ensure one-shot semantics.
         */
	retval = rtc_read_alarm(to_rtc_device(dev), &alm);
	if (retval == 0 && alm.enabled) {
		rtc_tm_to_time(&alm.time, &alarm);
		retval = sprintf(buf, "%lu\n", alarm);
	}

	return retval;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
81
98.78%
4
80.00%
Dmitry Torokhov
1
1.22%
1
20.00%
Total
82
100.00%
5
100.00%


static ssize_t

wakealarm_store(struct device *dev, struct device_attribute *attr,
		const char *buf, size_t n)
{
	ssize_t retval;
	unsigned long now, alarm;
	unsigned long push = 0;
	struct rtc_wkalrm alm;
	struct rtc_device *rtc = to_rtc_device(dev);
	const char *buf_ptr;
	int adjust = 0;

	/* Only request alarms that trigger in the future.  Disable them
         * by writing another time, e.g. 0 meaning Jan 1 1970 UTC.
         */
	retval = rtc_read_time(rtc, &alm.time);
	if (retval < 0)
		return retval;
	rtc_tm_to_time(&alm.time, &now);

	buf_ptr = buf;
	if (*buf_ptr == '+') {
		buf_ptr++;
		if (*buf_ptr == '=') {
			buf_ptr++;
			push = 1;
		} else
			adjust = 1;
	}
	retval = kstrtoul(buf_ptr, 0, &alarm);
	if (retval)
		return retval;
	if (adjust) {
		alarm += now;
	}
	if (alarm > now || push) {
		/* Avoid accidentally clobbering active alarms; we can't
                 * entirely prevent that here, without even the minimal
                 * locking from the /dev/rtcN api.
                 */
		retval = rtc_read_alarm(rtc, &alm);
		if (retval < 0)
			return retval;
		if (alm.enabled) {
			if (push) {
				rtc_tm_to_time(&alm.time, &push);
				alarm += push;
			} else
				return -EBUSY;
		} else if (push)
			return -EINVAL;
		alm.enabled = 1;
	} else {
		alm.enabled = 0;

		/* Provide a valid future alarm time.  Linux isn't EFI,
                 * this time won't be ignored when disabling the alarm.
                 */
		alarm = now + 300;
	}
	rtc_time_to_tm(alarm, &alm.time);

	retval = rtc_set_alarm(rtc, &alm);
	return (retval < 0) ? retval : n;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
176
61.11%
3
37.50%
Bernie Thompson
58
20.14%
1
12.50%
Yakui Zhao
40
13.89%
1
12.50%
Corentin Labbe
13
4.51%
2
25.00%
Dmitry Torokhov
1
0.35%
1
12.50%
Total
288
100.00%
8
100.00%

static DEVICE_ATTR_RW(wakealarm);


static ssize_t

offset_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	ssize_t retval;
	long offset;

	retval = rtc_read_offset(to_rtc_device(dev), &offset);
	if (retval == 0)
		retval = sprintf(buf, "%ld\n", offset);

	return retval;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Joshua Clayton
59
100.00%
1
100.00%
Total
59
100.00%
1
100.00%


static ssize_t

offset_store(struct device *dev, struct device_attribute *attr,
	     const char *buf, size_t n)
{
	ssize_t retval;
	long offset;

	retval = kstrtol(buf, 10, &offset);
	if (retval == 0)
		retval = rtc_set_offset(to_rtc_device(dev), offset);

	return (retval < 0) ? retval : n;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Joshua Clayton
71
100.00%
1
100.00%
Total
71
100.00%
1
100.00%

static DEVICE_ATTR_RW(offset);


static struct attribute *rtc_attrs[] = {
	&dev_attr_name.attr,
	&dev_attr_date.attr,
	&dev_attr_time.attr,
	&dev_attr_since_epoch.attr,
	&dev_attr_max_user_freq.attr,
	&dev_attr_hctosys.attr,
	&dev_attr_wakealarm.attr,
	&dev_attr_offset.attr,
	NULL,
};

/* The reason to trigger an alarm with no process watching it (via sysfs)
 * is its side effect:  waking from a system state like suspend-to-RAM or
 * suspend-to-disk.  So: no attribute unless that side effect is possible.
 * (Userspace may disable that mechanism later.)
 */


static bool rtc_does_wakealarm(struct rtc_device *rtc)
{
	if (!device_can_wakeup(rtc->dev.parent))
		return false;

	return rtc->ops->set_alarm != NULL;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
33
94.29%
3
75.00%
Dmitry Torokhov
2
5.71%
1
25.00%
Total
35
100.00%
4
100.00%



static umode_t rtc_attr_is_visible(struct kobject *kobj,
				   struct attribute *attr, int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
	struct rtc_device *rtc = to_rtc_device(dev);
	umode_t mode = attr->mode;

	if (attr == &dev_attr_wakealarm.attr) {
		if (!rtc_does_wakealarm(rtc))
			mode = 0;
	} else if (attr == &dev_attr_offset.attr) {
		if (!rtc->ops->set_offset)
			mode = 0;
	}

	return mode;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Dmitry Torokhov
57
55.88%
1
16.67%
Joshua Clayton
27
26.47%
1
16.67%
David Brownell
13
12.75%
3
50.00%
Alessandro Zummo
5
4.90%
1
16.67%
Total
102
100.00%
6
100.00%


static struct attribute_group rtc_attr_group = {
	.is_visible	= rtc_attr_is_visible,
	.attrs		= rtc_attrs,
};


static const struct attribute_group *rtc_attr_groups[] = {
	&rtc_attr_group,
	NULL
};



const struct attribute_group **rtc_get_dev_attribute_groups(void)
{
	return rtc_attr_groups;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Dmitry Torokhov
9
64.29%
1
33.33%
Alessandro Zummo
3
21.43%
1
33.33%
David Brownell
2
14.29%
1
33.33%
Total
14
100.00%
3
100.00%

Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
348
27.88%
5
25.00%
Alessandro Zummo
239
19.15%
1
5.00%
Joshua Clayton
168
13.46%
1
5.00%
Dmitry Torokhov
144
11.54%
3
15.00%
Bryan Kadzban
101
8.09%
1
5.00%
Matthew Garrett
61
4.89%
1
5.00%
Bernie Thompson
58
4.65%
1
5.00%
Greg Kroah-Hartman
43
3.45%
1
5.00%
Yakui Zhao
40
3.21%
1
5.00%
Corentin Labbe
31
2.48%
2
10.00%
Alexandre Belloni
10
0.80%
1
5.00%
Uwe Kleine-König
4
0.32%
1
5.00%
David Fries
1
0.08%
1
5.00%
Total
1248
100.00%
20
100.00%
Directory: drivers/rtc

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.