update rtc documentation wrt irq_set_freq

PATCH New Mike Frysinger 1 participant 1 message Jan 31, 2008 Documentation

Share & tools

Mike Frysinger

author

2008-01-31 23:17 UTC #0 lore raw

PATCH 1/1 update rtc documentation wrt irq_set_freq

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 <[email protected]>

---

Documentation/rtc.txt +2 -2

index e20b19c..8deffcd 100644
@@ -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!