leds: Further document parameters for blink_set()
PATCH 1/1 leds: Further document parameters for blink_set()
The documentation for the parameters of blink_set() was a bit hard to find so put some where I'd expected to find it.
--- include/linux/leds.h | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)
include/linux/leds.h +3 -1
@@ -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);
Signature · 1 line
1.6.3.1
Quoted 13 lines · Mark Brown
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 <[email protected]>--- include/linux/leds.h | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)include/linux/leds.h +0
-0
include/linux/leds.h struct led_classdev { · line 53
Quoted 10 lines
include/linux/leds.h +3
-1@@ -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);
What a strange calling convention. Does it return data in *delay_on/off ? Should that also be documented?
Pavel
Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
Quoted 17 lines · Pavel Machek
Quoted 16 lines · Mark Brown
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 <[email protected]>--- include/linux/leds.h | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-)include/linux/leds.h +0
-0@@ -45,7 +45,9 @@ struct led_classdev {/* Get LED brightness level */ enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);
Quoted 10 lines
include/linux/leds.h struct led_classdev { · line 53
Quoted 7 lines
include/linux/leds.h +3
-1-/* 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);What a strange calling convention. Does it return data in *delay_on/off ?
It was done so the caller could find out what timings the underlying hardware decided to chose if it couldn't match the timings specified exactly. This should be better documented and I'll take care of that.
Cheers,
Richard
Signature · 2 lines
Richard Purdie Intel Open Source Technology Centre