summaryrefslogtreecommitdiff
path: root/include/media
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2022-01-14 01:26:26 +0100
committerMauro Carvalho Chehab <mchehab@kernel.org>2023-01-22 09:25:11 +0100
commit1ec061243edeb729ac249b278bb241a846cc8e64 (patch)
tree389c3c2f415ab06113725c83b61e6de9f3ccb8f7 /include/media
parent7acd650a0484d92985a0d6d867d980c6dd019885 (diff)
media: mc: Improve the media_entity_has_pad_interdep() documentation
Document the function parameters, the requirements on the pad0 and pad1 arguments, the locking requirements and the return value. Also improve the documentation of the corresponding .has_pad_interdep() operation, stating clearly that the operation must be called through the media_entity_has_pad_interdep() function only. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Diffstat (limited to 'include/media')
-rw-r--r--include/media/media-entity.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/media/media-entity.h b/include/media/media-entity.h
index 85ed08ddee9d..47863e8fde7b 100644
--- a/include/media/media-entity.h
+++ b/include/media/media-entity.h
@@ -242,7 +242,9 @@ struct media_pad {
* part of the same pipeline and enabling one of the pads
* means that the other pad will become "locked" and
* doesn't allow configuration changes. pad0 and pad1 are
- * guaranteed to not both be sinks or sources.
+ * guaranteed to not both be sinks or sources. Never call
+ * the .has_pad_interdep() operation directly, always use
+ * media_entity_has_pad_interdep().
* Optional: If the operation isn't implemented all pads
* will be considered as interdependent.
*