diff options
| author | Mike Frysinger <vapier.adi@gmail.com> | 2007-11-14 16:58:43 -0800 |
|---|---|---|
| committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-11-14 18:45:37 -0800 |
| commit | 108b4c3638be251d6b42eaa633e8a6b852b960f0 (patch) | |
| tree | d589748dee20f9a20739c8cc72c8b0b168cce939 /Documentation/rtc.txt | |
| parent | fcbaa088fc8625381bd1096bc2eedc4f58a1572c (diff) | |
| download | linux-3.10-108b4c3638be251d6b42eaa633e8a6b852b960f0.tar.gz linux-3.10-108b4c3638be251d6b42eaa633e8a6b852b960f0.tar.bz2 linux-3.10-108b4c3638be251d6b42eaa633e8a6b852b960f0.zip | |
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>
Diffstat (limited to 'Documentation/rtc.txt')
| -rw-r--r-- | Documentation/rtc.txt | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/rtc.txt b/Documentation/rtc.txt index c931d613f64..e20b19c1b60 100644 --- a/Documentation/rtc.txt +++ b/Documentation/rtc.txt @@ -180,9 +180,10 @@ driver returns ENOIOCTLCMD. Some common examples: * 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 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 - initialization routines so the framework can sanity check the user - input for you. + structure. Your driver needs to initialize the irq_freq member during + init. Make sure you check the requested frequency is in range of your + 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! |