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

Commit 02f028cf authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] dvb_frontend.h: Add a description for the header 



This header file provides the kABI functions used by the
Digital TV Frontend core support. Add a description for
this kABI, to add at the device_drivers Kernel DocBook.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 66f4b3cb

Documentation/DocBook/device-drivers.tmpl

+1 −0
Original line number Diff line number Diff line
@@ -244,6 +244,7 @@ X!Isound/sound_firmware.c 
!Idrivers/media/dvb-core/dvbdev.h

	</sect1>

	<sect1><title>Digital TV Frontend kABI</title>

!Pdrivers/media/dvb-core/dvb_frontend.h Digital TV Frontend

!Idrivers/media/dvb-core/dvb_frontend.h

	</sect1>

	<sect1><title>Digital TV Demux kABI</title>

drivers/media/dvb-core/dvb_frontend.h

+23 −0
Original line number Diff line number Diff line
@@ -42,6 +42,29 @@ 


#include "dvbdev.h"



/**

 * DOC: Digital TV Frontend

 *

 * The Digital TV Frontend kABI defines a driver-internal interface for

 * registering low-level, hardware specific driver to a hardware independent

 * frontend layer. It is only of interest for Digital TV device driver writers.

 * The header file for this API is named dvb_frontend.h and located in

 * drivers/media/dvb-core.

 *

 * Before using the Digital TV frontend core, the bridge driver should attach

 * the frontend demod, tuner and SEC devices and call dvb_register_frontend(),

 * in order to register the new frontend at the subsystem. At device

 * detach/removal, the bridge driver should call dvb_unregister_frontend() to

 * remove the frontend from the core and then dvb_frontend_detach() to free the

 * memory allocated by the frontend drivers.

 *

 * The drivers should also call dvb_frontend_suspend() as part of their

 * handler for the &device_driver.suspend(), and dvb_frontend_resume() as

 * part of their handler for &device_driver.resume().

 *

 * A few other optional functions are provided to handle some special cases.

 */



/*

 * Maximum number of Delivery systems per frontend. It

 * should be smaller or equal to 32