Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] dvb_frontend.h: document the struct dvb_frontend

That struct is used on every DVB Front End driver, as it
contains what's needed to register/use a frontend at the
Kernel.

Document it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>

+19
+19
drivers/media/dvb-core/dvb_frontend.h
··· 647 647 #define DVB_FE_DEVICE_REMOVED 2 648 648 #define DVB_FE_DEVICE_RESUME 3 649 649 650 + /** 651 + * struct dvb_frontend - Frontend structure to be used on drivers. 652 + * 653 + * @ops: embedded struct dvb_frontend_ops 654 + * @dvb: pointer to struct dvb_adapter 655 + * @demodulator_priv: demod private data 656 + * @tuner_priv: tuner private data 657 + * @frontend_priv: frontend private data 658 + * @sec_priv: SEC private data 659 + * @analog_demod_priv: Analog demod private data 660 + * @dtv_property_cache: embedded struct dtv_frontend_properties 661 + * @callback: callback function used on some drivers to call 662 + * either the tuner or the demodulator. 663 + * @id: Frontend ID 664 + * @exit: Used to inform the DVB core that the frontend 665 + * thread should exit (usually, means that the hardware 666 + * got disconnected. 667 + */ 668 + 650 669 struct dvb_frontend { 651 670 struct dvb_frontend_ops ops; 652 671 struct dvb_adapter *dvb;