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

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

media: cec-core.rst: document the adap_free callback 



Document what this callback does.

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Reviewed-by: default avatarMaxime Ripard <maxime.ripard@free-electrons.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent e6259b5f

Documentation/media/kapi/cec-core.rst

+9 −0
Original line number Diff line number Diff line
@@ -107,6 +107,7 @@ your driver: 
		int (*adap_transmit)(struct cec_adapter *adap, u8 attempts,

				      u32 signal_free_time, struct cec_msg *msg);

		void (*adap_status)(struct cec_adapter *adap, struct seq_file *file);

		void (*adap_free)(struct cec_adapter *adap);



		/* High-level callbacks */

		...
@@ -184,6 +185,14 @@ To log the current CEC hardware status: 
This optional callback can be used to show the status of the CEC hardware.

The status is available through debugfs: cat /sys/kernel/debug/cec/cecX/status



To free any resources when the adapter is deleted:



.. c:function::

	void (*adap_free)(struct cec_adapter *adap);



This optional callback can be used to free any resources that might have been

allocated by the driver. It's called from cec_delete_adapter.





Your adapter driver will also have to react to events (typically interrupt

driven) by calling into the framework in the following situations: