linux-media.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] cec-core.rst: document the new cec_get_drvdata() helper
@ 2017-03-27  9:53 Hans Verkuil
  2017-03-27 11:26 ` Jose Abreu
  0 siblings, 1 reply; 2+ messages in thread
From: Hans Verkuil @ 2017-03-27  9:53 UTC (permalink / raw)
  To: Linux Media Mailing List; +Cc: Jose Abreu

Document the new cec_get_drvdata() helper function.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
---
diff --git a/Documentation/media/kapi/cec-core.rst b/Documentation/media/kapi/cec-core.rst
index 81c6d8e93774..8ea3a783f968 100644
--- a/Documentation/media/kapi/cec-core.rst
+++ b/Documentation/media/kapi/cec-core.rst
@@ -51,6 +51,7 @@ ops:

 priv:
 	will be stored in adap->priv and can be used by the adapter ops.
+	Use cec_get_drvdata(adap) to get the priv pointer.

 name:
 	the name of the CEC adapter. Note: this name will be copied.
@@ -65,6 +66,10 @@ available_las:
 	the number of simultaneous logical addresses that this
 	adapter can handle. Must be 1 <= available_las <= CEC_MAX_LOG_ADDRS.

+To obtain the priv pointer use this helper function:
+
+.. c:function::
+	void *cec_get_drvdata(const struct cec_adapter *adap);

 To register the /dev/cecX device node and the remote control device (if
 CEC_CAP_RC is set) you call:

^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2017-03-27 11:28 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-03-27  9:53 [PATCH] cec-core.rst: document the new cec_get_drvdata() helper Hans Verkuil
2017-03-27 11:26 ` Jose Abreu

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).