diff mbox

[v2,3/3] v4l2-flash-led-class: Document v4l2_flash_init() references

Message ID 20170809111555.30147-4-sakari.ailus@linux.intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

Sakari Ailus Aug. 9, 2017, 11:15 a.m. UTC
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>
---
 include/media/v4l2-flash-led-class.h | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Hans Verkuil Aug. 10, 2017, 1:16 p.m. UTC | #1
On 09/08/17 13:15, Sakari Ailus wrote:
> 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>

Regards,

	Hans

> ---
>  include/media/v4l2-flash-led-class.h | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/include/media/v4l2-flash-led-class.h b/include/media/v4l2-flash-led-class.h
> index c3f39992f3fa..6f4825b6a352 100644
> --- a/include/media/v4l2-flash-led-class.h
> +++ b/include/media/v4l2-flash-led-class.h
> @@ -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
>   *
>   * 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
>   * 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
>   *
>   * 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
>   * value is encoded using ERR_PTR(). Use IS_ERR() to check and
>
diff mbox

Patch

diff --git a/include/media/v4l2-flash-led-class.h b/include/media/v4l2-flash-led-class.h
index c3f39992f3fa..6f4825b6a352 100644
--- a/include/media/v4l2-flash-led-class.h
+++ b/include/media/v4l2-flash-led-class.h
@@ -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
  *
  * 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
  * 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
  *
  * 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
  * value is encoded using ERR_PTR(). Use IS_ERR() to check and