From 8a0ba4e0178f4d87445b5527bfefdd5437b974c6 Mon Sep 17 00:00:00 2001 From: Mike Frysinger Date: Wed, 6 Feb 2008 01:38:56 -0800 Subject: rtc: update documentation wrt irq_set_freq Document the proper use of the irq_set_freq function. Signed-off-by: Mike Frysinger Cc: Alessandro Zummo Cc: David Brownell Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/rtc.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/rtc.txt b/Documentation/rtc.txt index e20b19c1b60..804a7cf6bd1 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! -- cgit v1.2.3-18-g5258