| Message ID | 1252081568-6000-1-git-send-email-mjg@redhat.com |
|---|---|
| State | Accepted, archived |
| Headers | show |
On Fri, 4 Sep 2009 12:26:07 -0400 Matthew Garrett <mjg@redhat.com> wrote: > 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> thanks! Acked-by: Alessandro Zummo <a.zummo@towertech.it>
On Fri, Sep 04, 2009 at 12:26:07PM -0400, Matthew Garrett wrote: > 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> > +SYSFS INTERFACE > +--------------- Wouldn't this be better placed under Documentation/ABI? --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to "rtc-linux". Membership options at http://groups.google.com/group/rtc-linux . Please read http://groups.google.com/group/rtc-linux/web/checklist before submitting a driver. -~----------~----~----~----~------~----~------~--~---
On Fri, Sep 04, 2009 at 05:35:21PM +0100, Mark Brown wrote: > On Fri, Sep 04, 2009 at 12:26:07PM -0400, Matthew Garrett wrote: > > > 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> > > > +SYSFS INTERFACE > > +--------------- > > Wouldn't this be better placed under Documentation/ABI? Unsure. I'd assumed it made more sense in the existing docs.
On Fri, Sep 04, 2009 at 05:39:18PM +0100, Matthew Garrett wrote: > On Fri, Sep 04, 2009 at 05:35:21PM +0100, Mark Brown wrote: > > Wouldn't this be better placed under Documentation/ABI? > Unsure. I'd assumed it made more sense in the existing docs. My understanding is that the sysfs ABI (and ABIs in general, I guess) should be moving towards the more formal style of Documentation/ABI to help manage userspace expectations - the separation of the documentation applies to most other things in there as well. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to "rtc-linux". Membership options at http://groups.google.com/group/rtc-linux . Please read http://groups.google.com/group/rtc-linux/web/checklist before submitting a driver. -~----------~----~----~----~------~----~------~--~---
On Fri, 4 Sep 2009 17:52:06 +0100 Mark Brown <broonie@opensource.wolfsonmicro.com> wrote: > On Fri, Sep 04, 2009 at 05:39:18PM +0100, Matthew Garrett wrote: > > On Fri, Sep 04, 2009 at 05:35:21PM +0100, Mark Brown wrote: > > > > Wouldn't this be better placed under Documentation/ABI? > > > Unsure. I'd assumed it made more sense in the existing docs. > > My understanding is that the sysfs ABI (and ABIs in general, I guess) > should be moving towards the more formal style of Documentation/ABI to > help manage userspace expectations - the separation of the documentation > applies to most other things in there as well. Yes, I think you're right. But I'm not going to pass on a documentation patch just because it's in the wrong place ;) --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to "rtc-linux". Membership options at http://groups.google.com/group/rtc-linux . Please read http://groups.google.com/group/rtc-linux/web/checklist before submitting a driver. -~----------~----~----~----~------~----~------~--~---
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
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(-)