Skip to content

Commit 40cefff

Browse files
Sakari Ailusmchehab
authored andcommitted
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 <[email protected]> Acked-by: Pavel Machek <[email protected]> Acked-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
1 parent 503dd28 commit 40cefff

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

include/media/v4l2-flash-led-class.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,9 @@ static inline struct v4l2_flash *v4l2_ctrl_to_v4l2_flash(struct v4l2_ctrl *c)
112112
* @config: initialization data for V4L2 Flash sub-device
113113
*
114114
* Create V4L2 Flash sub-device wrapping given LED subsystem device.
115+
* The ops pointer is stored by the V4L2 flash framework. No
116+
* references are held to config nor its contents once this function
117+
* has returned.
115118
*
116119
* Returns: A valid pointer, or, when an error occurs, the return
117120
* value is encoded using ERR_PTR(). Use IS_ERR() to check and
@@ -130,6 +133,9 @@ struct v4l2_flash *v4l2_flash_init(
130133
* @config: initialization data for V4L2 Flash sub-device
131134
*
132135
* Create V4L2 Flash sub-device wrapping given LED subsystem device.
136+
* The ops pointer is stored by the V4L2 flash framework. No
137+
* references are held to config nor its contents once this function
138+
* has returned.
133139
*
134140
* Returns: A valid pointer, or, when an error occurs, the return
135141
* value is encoded using ERR_PTR(). Use IS_ERR() to check and

0 commit comments

Comments
 (0)