Commit a21512c1 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Alexandre Belloni
Browse files

rtc.txt: standardize document format 



Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:

- adjust identation of the titles;
- mark a table as such;
- don't capitalize chapter names.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarAlexandre Belloni <alexandre.belloni@free-electrons.com>
parent da96aea0

Documentation/rtc.txt

+23 −21
Original line number Diff line number Diff line 


=======================================

Real Time Clock (RTC) Drivers for Linux

=======================================
@@ -136,35 +136,37 @@ 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

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

hctosys:   	 1 if the RTC provided the system time at boot via the

================ ==============================================================

date  	   	 RTC-provided date

hctosys   	 1 if the RTC provided the system time at boot via the

		 CONFIG_RTC_HCTOSYS kernel option, 0 otherwise

max_user_freq:	 The maximum interrupt rate an unprivileged user may request

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

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 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.

offset:		 The amount which the rtc clock has been adjusted in firmware.

		 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.

offset		 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.

================ ==============================================================



IOCTL INTERFACE

IOCTL interface

---------------



The ioctl() calls supported by /dev/rtc are also supported by the RTC class

CRA Git | Maintained and supported by SUSTech CRA and CCSE