Re: [PATCH] cec-core.rst: document the new cec_get_drvdata() helper

[Jose Abreu <Jose.Abreu@synopsys.com>]

Hi Hans,


Thanks! I totally forgot about the documentation update.


On 27-03-2017 10:53, Hans Verkuil wrote:
> Document the new cec_get_drvdata() helper function.
>
> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>

Reviewed-by: Jose Abreu <joabreu@synopsys.com>

Best regards,
Jose Miguel Abreu

> ---
> 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: