mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

rtc: tweak driver documentation for rtc periodic 

The max_user_freq member is not really meant for RTC drivers to modify, so
update the rtc documentation so drivers writers know what is expected of
them when handling periodic events.

Signed-off-by: Mike Frysinger <vapier@gentoo.org>
Acked-by: Alessandro Zummo <a.zummo@towertech.it>
Cc: David Brownell <david-b@pacbell.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Mike Frysinger 2007-11-14 16:58:43 -08:00 committed by Linus Torvalds
parent fcbaa088fc
commit 108b4c3638
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/rtc.txt
View File

@ -180,9 +180,10 @@ driver returns ENOIOCTLCMD. Some common examples:
* RTC_IRQP_SET, RTC_IRQP_READ: the irq_set_freq function will be called * RTC_IRQP_SET, RTC_IRQP_READ: the irq_set_freq function will be called
to set the frequency while the framework will handle the read for you to set the frequency while the framework will handle the read for you
since the frequency is stored in the irq_freq member of the rtc_device since the frequency is stored in the irq_freq member of the rtc_device
structure. Also make sure you set the max_user_freq member in your structure. Your driver needs to initialize the irq_freq member during
initialization routines so the framework can sanity check the user init. Make sure you check the requested frequency is in range of your
input for you. hardware in the irq_set_freq function. If you cannot actually change
the frequency, just return -ENOTTY.
If all else fails, check out the rtc-test.c driver! If all else fails, check out the rtc-test.c driver!