leds: Futher document blink_set
authorRichard Purdie <rpurdie@linux.intel.com>
Mon, 22 Jun 2009 13:54:13 +0000 (14:54 +0100)
committerRichard Purdie <rpurdie@linux.intel.com>
Tue, 23 Jun 2009 19:21:39 +0000 (20:21 +0100)
Futher document blink_set function pointer

Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
include/linux/leds.h

index 62af62915cf750a561e5231b0cb04b9a25f72e5d..d8bf9665e70cc09b40d781a82c638e1b95dd82af 100644 (file)
@@ -47,7 +47,8 @@ struct led_classdev {
 
        /* Activate hardware accelerated blink, delays are in
         * miliseconds and if none is provided then a sensible default
-        * should be chosen. */
+        * should be chosen. The call can adjust the timings if it can't
+        * match the values specified exactly. */
        int             (*blink_set)(struct led_classdev *led_cdev,
                                     unsigned long *delay_on,
                                     unsigned long *delay_off);