media: v4l2-flash-led-class: Document v4l2_flash_init() references

The v4l2_flash_init() keeps a reference to the ops struct but not to the
config struct (nor anything it contains). Document this.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Acked-by: Pavel Machek <pavel@ucw.cz>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Sakari Ailus 2017-07-19 18:38:36 -04:00 committed by Mauro Carvalho Chehab
parent 503dd28af1
commit 40cefffd35
1 changed files with 6 additions and 0 deletions

View File

@ -112,6 +112,9 @@ static inline struct v4l2_flash *v4l2_ctrl_to_v4l2_flash(struct v4l2_ctrl *c)
* @config: initialization data for V4L2 Flash sub-device * @config: initialization data for V4L2 Flash sub-device
* *
* Create V4L2 Flash sub-device wrapping given LED subsystem device. * Create V4L2 Flash sub-device wrapping given LED subsystem device.
* The ops pointer is stored by the V4L2 flash framework. No
* references are held to config nor its contents once this function
* has returned.
* *
* Returns: A valid pointer, or, when an error occurs, the return * Returns: A valid pointer, or, when an error occurs, the return
* value is encoded using ERR_PTR(). Use IS_ERR() to check and * value is encoded using ERR_PTR(). Use IS_ERR() to check and
@ -130,6 +133,9 @@ struct v4l2_flash *v4l2_flash_init(
* @config: initialization data for V4L2 Flash sub-device * @config: initialization data for V4L2 Flash sub-device
* *
* Create V4L2 Flash sub-device wrapping given LED subsystem device. * Create V4L2 Flash sub-device wrapping given LED subsystem device.
* The ops pointer is stored by the V4L2 flash framework. No
* references are held to config nor its contents once this function
* has returned.
* *
* Returns: A valid pointer, or, when an error occurs, the return * Returns: A valid pointer, or, when an error occurs, the return
* value is encoded using ERR_PTR(). Use IS_ERR() to check and * value is encoded using ERR_PTR(). Use IS_ERR() to check and