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

Commit 4bc645df authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] DocBook: finish documenting struct dmx_demux 



There are two callbacks still not documented:
	.//drivers/media/dvb-core/demux.h:422: warning: No description found for parameter 'get_pes_pids'
	.//drivers/media/dvb-core/demux.h:422: warning: No description found for parameter 'get_stc'

The purpose of first one is clear. The second one is used only
on the obsolete av7110 driver, and its purpose is not clear,
as it just returns a 64-bit word from the firmware to userspace.

Let's document get_pes_pids and mark get_stc as private, adding
a comment to not use it, while this is not documented.

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

drivers/media/dvb-core/demux.h

+15 −1
Original line number Diff line number Diff line
@@ -381,6 +381,16 @@ struct dmx_frontend { 
 *	It returns

 *		0 on success;

 *		-EINVAL on bad parameter.

 *

 * @get_pes_pids: Get the PIDs for DMX_PES_AUDIO0, DMX_PES_VIDEO0,

 *	DMX_PES_TELETEXT0, DMX_PES_SUBTITLE0 and DMX_PES_PCR0.

 *	The @demux function parameter contains a pointer to the demux API and

 *	instance data.

 *	The @pids function parameter contains an array with five u16 elements

 *	where the PIDs will be stored.

 *	It returns

 *		0 on success;

 *		-EINVAL on bad parameter.

 */



struct dmx_demux {
@@ -416,7 +426,11 @@ struct dmx_demux { 
	int (*get_caps) (struct dmx_demux* demux, struct dmx_caps *caps);

	int (*set_source) (struct dmx_demux* demux, const dmx_source_t *src);

#endif

	/* public: */

	/*

	 * private: Only used at av7110, to read some data from firmware.

	 *	As this was never documented, we have no clue about what's

	 * 	there, and its usage on other drivers aren't encouraged.

	 */

	int (*get_stc) (struct dmx_demux* demux, unsigned int num,

			u64 *stc, unsigned int *base);

};