Documentation: rtc: add sysfs file permissions
authorAishwarya Pant <aishpant@gmail.com>
Mon, 1 Jan 2018 17:30:42 +0000 (23:00 +0530)
committerAlexandre Belloni <alexandre.belloni@free-electrons.com>
Thu, 11 Jan 2018 23:20:41 +0000 (00:20 +0100)
Annotate the sysfs interface of rtc with file specific permissions
(RO/RW).

Signed-off-by: Aishwarya Pant <aishpant@gmail.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
Documentation/ABI/testing/sysfs-class-rtc

index a19f5e2def3a2a04f8c4dd66e91ddfcc6e859616..cf60412882f0ded5c3cdc577f18cb36b05b1866b 100644 (file)
@@ -18,14 +18,14 @@ Date:               March 2006
 KernelVersion: 2.6.17
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               RTC-provided date in YYYY-MM-DD format
+               (RO) RTC-provided date in YYYY-MM-DD format
 
 What:          /sys/class/rtc/rtcX/hctosys
 Date:          September 2009
 KernelVersion: 2.6.32
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               1 if the RTC provided the system time at boot via the
+               (RO) 1 if the RTC provided the system time at boot via the
                CONFIG_RTC_HCTOSYS kernel option, 0 otherwise
 
 What:          /sys/class/rtc/rtcX/max_user_freq
@@ -33,7 +33,7 @@ Date:         October 2007
 KernelVersion: 2.6.24
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               The maximum interrupt rate an unprivileged user may request
+               (RW) The maximum interrupt rate an unprivileged user may request
                from this RTC.
 
 What:          /sys/class/rtc/rtcX/name
@@ -41,49 +41,51 @@ Date:               March 2006
 KernelVersion: 2.6.17
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               The name of the RTC corresponding to this sysfs directory
+               (RO) The name of the RTC corresponding to this sysfs directory
 
 What:          /sys/class/rtc/rtcX/since_epoch
 Date:          March 2006
 KernelVersion: 2.6.17
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               RTC-provided time as the number of seconds since the epoch
+               (RO) RTC-provided time as the number of seconds since the epoch
 
 What:          /sys/class/rtc/rtcX/time
 Date:          March 2006
 KernelVersion: 2.6.17
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               RTC-provided time in 24-hour notation (hh:mm:ss)
+               (RO) RTC-provided time in 24-hour notation (hh:mm:ss)
 
 What:          /sys/class/rtc/rtcX/*/nvmem
 Date:          February 2016
 KernelVersion: 4.6
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               The non volatile storage exported as a raw file, as described in
-               Documentation/nvmem/nvmem.txt
+               (RW) The non volatile storage exported as a raw file, as
+               described in Documentation/nvmem/nvmem.txt
 
 What:          /sys/class/rtc/rtcX/offset
 Date:          February 2016
 KernelVersion: 4.6
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               The amount which the rtc clock has been adjusted in firmware.
-               Visible only if the driver supports clock offset adjustment.
-               The unit is parts per billion, i.e. The number of clock ticks
-               which are added to or removed from the rtc's base clock per
-               billion ticks. A positive value makes a day pass more slowly,
-               longer, and a negative value makes a day pass more quickly.
+               (RW) The amount which the rtc clock has been adjusted in
+               firmware. Visible only if the driver supports clock offset
+               adjustment. The unit is parts per billion, i.e. The number of
+               clock ticks which are added to or removed from the rtc's base
+               clock per billion ticks. A positive value makes a day pass more
+               slowly, longer, and a negative value makes a day pass more
+               quickly.
 
 What:          /sys/class/rtc/rtcX/wakealarm
 Date:          February 2007
 KernelVersion: 2.6.20
 Contact:       linux-rtc@vger.kernel.org
 Description:
-               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 seconds since the epoch by
-               default, or if there's a leading +, seconds in the future, or if
-               there is a leading +=, seconds ahead of the current alarm.
+               (RW) 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 seconds since the
+               epoch by default, or if there's a leading +, seconds in the
+               future, or if there is a leading +=, seconds ahead of the
+               current alarm.