mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Matthew Garrett <mjg@redhat.com>
To: linux-kernel@vger.kernel.org
Cc: a.zummo@towertech.it, rtc-linux@googlegroups.com,
	Matthew Garrett <mjg@redhat.com>
Subject: [PATCH 1/2] rtc: Document the sysfs interface
Date: Fri,  4 Sep 2009 12:26:07 -0400	[thread overview]
Message-ID: <1252081568-6000-1-git-send-email-mjg@redhat.com> (raw)

The sysfs interface to the RTC class drivers is currently undocumented.
Add some basic documentation defining the semantics of the fields.

Signed-off-by: Matthew Garrett <mjg@redhat.com>
---
 Documentation/rtc.txt |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)

diff --git a/Documentation/rtc.txt b/Documentation/rtc.txt
index 8deffcd..216bb8c 100644
--- a/Documentation/rtc.txt
+++ b/Documentation/rtc.txt
@@ -135,6 +135,28 @@ a high functionality RTC is integrated into the SOC.  That system might read
 the system clock from the discrete RTC, but use the integrated one for all
 other tasks, because of its greater functionality.
 
+SYSFS INTERFACE
+---------------
+
+The sysfs interface under /sys/class/rtc/rtcN provides access to various
+rtc attributes without requiring the use of ioctls. All dates and times
+are in the RTC's timezone, rather than in system time.
+
+date:  	   	 RTC-provided date
+max_user_freq:	 The maximum interrupt rate an unprivileged user may request
+		 from this RTC.
+name:		 The name of the RTC corresponding to this sysfs directory
+since_epoch:	 The number of seconds since the epoch according to the RTC
+time:		 RTC-provided time
+wakealarm:	 The time at which the clock will generate a system wakeup
+		 event. This is a one shot wakeup event, so must be reset
+		 after wake if a daily wakeup is required. Format is either
+		 seconds since the epoch or, if there's a leading +, seconds
+		 in the future.
+
+IOCTL INTERFACE
+---------------
+
 The ioctl() calls supported by /dev/rtc are also supported by the RTC class
 framework.  However, because the chips and systems are not standardized,
 some PC/AT functionality might not be provided.  And in the same way, some
-- 
1.6.4.1


             reply	other threads:[~2009-09-04 16:20 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-09-04 16:26 Matthew Garrett [this message]
2009-09-04 16:26 ` [PATCH 2/2] rtc: Add boot_timesource sysfs attribute Matthew Garrett
2009-09-04 16:25   ` [rtc-linux] " Alessandro Zummo
2009-09-04 16:30     ` Matthew Garrett
2009-09-04 16:38       ` [rtc-linux] " Alessandro Zummo
2009-09-04 16:41         ` Matthew Garrett
2009-09-04 16:52           ` Alessandro Zummo
2009-09-04 16:55             ` Matthew Garrett
2009-09-04 17:03               ` Alessandro Zummo
2009-09-04 17:09                 ` Matthew Garrett
2009-09-05 21:11                   ` Alessandro Zummo
2009-09-06  1:34                   ` Mark Brown
2009-09-14 22:59             ` Karel Zak
2009-09-04 16:26 ` [rtc-linux] [PATCH 1/2] rtc: Document the sysfs interface Alessandro Zummo
2009-09-04 16:35 ` Mark Brown
2009-09-04 16:39   ` Matthew Garrett
2009-09-04 16:52     ` [rtc-linux] " Mark Brown
2009-09-04 23:23       ` Andrew Morton

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1252081568-6000-1-git-send-email-mjg@redhat.com \
    --to=mjg@redhat.com \
    --cc=a.zummo@towertech.it \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rtc-linux@googlegroups.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

Powered by JetHome