Commit 8a0ba4e0 authored by Mike Frysinger's avatar Mike Frysinger Committed by Linus Torvalds

rtc: update documentation wrt irq_set_freq

Document the proper use of the irq_set_freq function.
Signed-off-by: default avatarMike Frysinger <vapier@gentoo.org>
Cc: Alessandro Zummo <a.zummo@towertech.it>
Cc: David Brownell <david-b@pacbell.net>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent fcd8db00
...@@ -182,8 +182,8 @@ driver returns ENOIOCTLCMD. Some common examples: ...@@ -182,8 +182,8 @@ driver returns ENOIOCTLCMD. Some common examples:
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. Your driver needs to initialize the irq_freq member during structure. Your driver needs to initialize the irq_freq member during
init. Make sure you check the requested frequency is in range of your 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 hardware in the irq_set_freq function. If it isn't, return -EINVAL. If
the frequency, just return -ENOTTY. you cannot actually change the frequency, do not define irq_set_freq.
If all else fails, check out the rtc-test.c driver! If all else fails, check out the rtc-test.c driver!
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment