* [patch] update rtc documentation wrt irq_set_freq
@ 2008-01-31 23:16 Mike Frysinger
0 siblings, 0 replies; only message in thread
From: Mike Frysinger @ 2008-01-31 23:16 UTC (permalink / raw)
To: a.zummo, Andrew Morton; +Cc: rtc-linux, linux-kernel
I could have sworn I sent this out already, but I don't see it in the latest
git or in mm, so here we go ...
---
This documents the proper use of the irq_set_freq function.
Signed-off-by: Mike Frysinger <vapier@gentoo.org>
---
diff --git a/Documentation/rtc.txt b/Documentation/rtc.txt
index e20b19c..8deffcd 100644
--- a/Documentation/rtc.txt
+++ b/Documentation/rtc.txt
@@ -182,8 +182,8 @@ driver returns ENOIOCTLCMD. Some common examples:
since the frequency is stored in the irq_freq member of the rtc_device
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.
+ hardware in the irq_set_freq function. If it isn't, return -EINVAL. If
+ you cannot actually change the frequency, do not define irq_set_freq.
If all else fails, check out the rtc-test.c driver!
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2008-01-31 23:17 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-01-31 23:16 [patch] update rtc documentation wrt irq_set_freq Mike Frysinger
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox