| Message ID | 20200517190139.740249-8-sam@ravnborg.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | backlight updates | expand |
On Sun, May 17, 2020 at 09:01:30PM +0200, Sam Ravnborg wrote: > Add documentation for the inline functions in backlight.h > > Signed-off-by: Sam Ravnborg <sam@ravnborg.org> > Cc: Lee Jones <lee.jones@linaro.org> > Cc: Daniel Thompson <daniel.thompson@linaro.org> > Cc: Jingoo Han <jingoohan1@gmail.com> > --- > include/linux/backlight.h | 16 ++++++++++++++++ > 1 file changed, 16 insertions(+) > > diff --git a/include/linux/backlight.h b/include/linux/backlight.h > index e2d72936bf05..98349a2984dc 100644 > --- a/include/linux/backlight.h > +++ b/include/linux/backlight.h > @@ -283,6 +283,10 @@ struct backlight_device { > int use_count; > }; > > +/** > + * backlight_update_status - force an update of the backligt device status Typo. Other than that, Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org> Daniel. > + * @bd: the backlight device > + */ > static inline int backlight_update_status(struct backlight_device *bd) > { > int ret = -ENOENT; > @@ -375,6 +379,18 @@ extern int backlight_device_set_brightness(struct backlight_device *bd, unsigned > > #define to_backlight_device(obj) container_of(obj, struct backlight_device, dev) > > +/** > + * bl_get_data - access devdata > + * @bl_dev: pointer to backlight device > + * > + * When a backlight device is registered the driver has the possibility > + * to supply a void * devdata. bl_get_data() return a pointer to the > + * devdata. > + * > + * RETURNS: > + * > + * pointer to devdata stored while registering the backlight device. > + */ > static inline void * bl_get_data(struct backlight_device *bl_dev) > { > return dev_get_drvdata(&bl_dev->dev); > -- > 2.25.1 >
diff --git a/include/linux/backlight.h b/include/linux/backlight.h index e2d72936bf05..98349a2984dc 100644 --- a/include/linux/backlight.h +++ b/include/linux/backlight.h @@ -283,6 +283,10 @@ struct backlight_device { int use_count; }; +/** + * backlight_update_status - force an update of the backligt device status + * @bd: the backlight device + */ static inline int backlight_update_status(struct backlight_device *bd) { int ret = -ENOENT; @@ -375,6 +379,18 @@ extern int backlight_device_set_brightness(struct backlight_device *bd, unsigned #define to_backlight_device(obj) container_of(obj, struct backlight_device, dev) +/** + * bl_get_data - access devdata + * @bl_dev: pointer to backlight device + * + * When a backlight device is registered the driver has the possibility + * to supply a void * devdata. bl_get_data() return a pointer to the + * devdata. + * + * RETURNS: + * + * pointer to devdata stored while registering the backlight device. + */ static inline void * bl_get_data(struct backlight_device *bl_dev) { return dev_get_drvdata(&bl_dev->dev);
Add documentation for the inline functions in backlight.h Signed-off-by: Sam Ravnborg <sam@ravnborg.org> Cc: Lee Jones <lee.jones@linaro.org> Cc: Daniel Thompson <daniel.thompson@linaro.org> Cc: Jingoo Han <jingoohan1@gmail.com> --- include/linux/backlight.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+)