Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 15ae0be9 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

media: cec-core.rst: document the new adap_monitor_pin_enable op 



Document what this op does.

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 48ea2e92

Documentation/media/kapi/cec-core.rst

+14 −0
Original line number Diff line number Diff line
@@ -103,6 +103,7 @@ your driver: 
		/* Low-level callbacks */

		int (*adap_enable)(struct cec_adapter *adap, bool enable);

		int (*adap_monitor_all_enable)(struct cec_adapter *adap, bool enable);

		int (*adap_monitor_pin_enable)(struct cec_adapter *adap, bool enable);

		int (*adap_log_addr)(struct cec_adapter *adap, u8 logical_addr);

		int (*adap_transmit)(struct cec_adapter *adap, u8 attempts,

				      u32 signal_free_time, struct cec_msg *msg);
@@ -144,6 +145,19 @@ called if the CEC_CAP_MONITOR_ALL capability is set. This callback is optional 
Note that adap_monitor_all_enable must return 0 if enable is false.





To enable/disable the 'monitor pin' mode:



.. c:function::

	int (*adap_monitor_pin_enable)(struct cec_adapter *adap, bool enable);



If enabled, then the adapter should be put in a mode to also monitor CEC pin

changes. Not all hardware supports this and this function is only called if

the CEC_CAP_MONITOR_PIN capability is set. This callback is optional

(some hardware may always be in 'monitor pin' mode).



Note that adap_monitor_pin_enable must return 0 if enable is false.





To program a new logical address:



.. c:function::