History

backlight: backlight: Document inline functions in backlight.h

Add documentation for the inline functions in backlight.h

Sam Ravnborg committed 6 years ago

Commit d160fd41 parent 6f10cd11 file · +16 −0Browse files

Unified · Split

include/linux/backlight.h+16−0
@@ -268,6 +268,10 @@ struct backlight_device { · 267 unmodified lines
268268 int use_count;
269269 };
270270
271+/**
272+ * backlight_update_status - force an update of the backlight device status
273+ * @bd: the backlight device
274+ */
271275 static inline int backlight_update_status(struct backlight_device *bd)
272276 {
273277 int ret = -ENOENT;
@@ -361,6 +365,18 @@ extern int backlight_device_set_brightness(struct backlight_device *bd, unsigned · 87 unmodified lines
361365
362366 #define to_backlight_device(obj) container_of(obj, struct backlight_device, dev)
363367
368+/**
369+ * bl_get_data - access devdata
370+ * @bl_dev: pointer to backlight device
371+ *
372+ * When a backlight device is registered the driver has the possibility
373+ * to supply a void * devdata. bl_get_data() return a pointer to the
374+ * devdata.
375+ *
376+ * RETURNS:
377+ *
378+ * pointer to devdata stored while registering the backlight device.
379+ */
364380 static inline void * bl_get_data(struct backlight_device *bl_dev)
365381 {
366382 return dev_get_drvdata(&bl_dev->dev);