media: v4l2-mem2mem: add descriptions to MC fields
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Tue, 7 Aug 2018 10:06:17 +0000 (06:06 -0400)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Tue, 7 Aug 2018 10:10:16 +0000 (06:10 -0400)
drivers/media/v4l2-core/v4l2-mem2mem.c:90: warning: Function parameter or member 'source_pad' not described in 'v4l2_m2m_dev'
drivers/media/v4l2-core/v4l2-mem2mem.c:90: warning: Function parameter or member 'sink' not described in 'v4l2_m2m_dev'
drivers/media/v4l2-core/v4l2-mem2mem.c:90: warning: Function parameter or member 'sink_pad' not described in 'v4l2_m2m_dev'
drivers/media/v4l2-core/v4l2-mem2mem.c:90: warning: Function parameter or member 'proc' not described in 'v4l2_m2m_dev'
drivers/media/v4l2-core/v4l2-mem2mem.c:90: warning: Function parameter or member 'proc_pads' not described in 'v4l2_m2m_dev'
drivers/media/v4l2-core/v4l2-mem2mem.c:90: warning: Function parameter or member 'intf_devnode' not described in 'v4l2_m2m_dev'

Fixes: be2fff656322 ("media: add helpers for memory-to-memory media controller")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
drivers/media/v4l2-core/v4l2-mem2mem.c

index 0a93c5b..ce9bd1b 100644 (file)
@@ -66,6 +66,24 @@ static const char * const m2m_entity_name[] = {
 
 /**
  * struct v4l2_m2m_dev - per-device context
+ * @source:            &struct media_entity pointer with the source entity
+ *                     Used only when the M2M device is registered via
+ *                     v4l2_m2m_unregister_media_controller().
+ * @source_pad:                &struct media_pad with the source pad.
+ *                     Used only when the M2M device is registered via
+ *                     v4l2_m2m_unregister_media_controller().
+ * @sink:              &struct media_entity pointer with the sink entity
+ *                     Used only when the M2M device is registered via
+ *                     v4l2_m2m_unregister_media_controller().
+ * @sink_pad:          &struct media_pad with the sink pad.
+ *                     Used only when the M2M device is registered via
+ *                     v4l2_m2m_unregister_media_controller().
+ * @proc:              &struct media_entity pointer with the M2M device itself.
+ * @proc_pads:         &struct media_pad with the @proc pads.
+ *                     Used only when the M2M device is registered via
+ *                     v4l2_m2m_unregister_media_controller().
+ * @intf_devnode:      &struct media_intf devnode pointer with the interface
+ *                     with controls the M2M device.
  * @curr_ctx:          currently running instance
  * @job_queue:         instances queued to run
  * @job_spinlock:      protects job_queue