leds: Further document parameters for blink_set()
authorMark Brown <broonie@opensource.wolfsonmicro.com>
Thu, 11 Jun 2009 13:17:48 +0000 (14:17 +0100)
committerRichard Purdie <rpurdie@linux.intel.com>
Tue, 23 Jun 2009 19:20:35 +0000 (20:20 +0100)
The documentation for the parameters of blink_set() was a bit hard
to find so put some where I'd expected to find it.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
include/linux/leds.h

index 376fe07732ea9261dc81f3ff7411d49ac9051fb3..c7f0b148df06053b8f089ddd3c5c0bcb71f9f6bb 100644 (file)
@@ -45,7 +45,9 @@ struct led_classdev {
        /* Get LED brightness level */
        enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
 
-       /* Activate hardware accelerated blink */
+       /* Activate hardware accelerated blink, delays are in
+        * miliseconds and if none is provided then a sensible default
+        * should be chosen. */
        int             (*blink_set)(struct led_classdev *led_cdev,
                                     unsigned long *delay_on,
                                     unsigned long *delay_off);