leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[media] demux.h: Fix a few documentation issues

Browse Source 
demux.h was lacking documentation for the DMX_FE_ENTRY macro:
	./drivers/media/dvb-core/demux.h:511: WARNING: c:func reference target not found: DMX_FE_ENTRY

While here, get rid of unused parameters and fix a few minor issues
at the header file.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-08-29 10:05:49 -03:00
parent 9aa9d92890
commit bb501b76c7
1 changed files with 16 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
drivers/media/dvb-core/demux.h
View File

@ -202,7 +202,7 @@ struct dmx_section_feed {
*
* This function callback prototype, provided by the client of the demux API,
* is called from the demux code. The function is only called when filtering
* on ae TS feed has been enabled using the start_filtering() function at
* on a TS feed has been enabled using the start_filtering\(\) function at
* the &dmx_demux.
* Any TS packets that match the filter settings are copied to a circular
* buffer. The filtered TS packets are delivered to the client using this
@ -243,8 +243,10 @@ struct dmx_section_feed {
* will also be sent to the hardware MPEG decoder.
*
* Return:
* 0, on success;
* -EOVERFLOW, on buffer overflow.
*
* - 0, on success;
*
* - -EOVERFLOW, on buffer overflow.
*/
typedef int (*dmx_ts_cb)(const u8 *buffer1,
size_t buffer1_length,
@ -293,9 +295,9 @@ typedef int (*dmx_section_cb)(const u8 *buffer1,
size_t buffer2_len,
struct dmx_section_filter *source);
/*--------------------------------------------------------------------------*/
/* DVB Front-End */
/*--------------------------------------------------------------------------*/
/*
* DVB Front-End
*/
/**
* enum dmx_frontend_source - Used to identify the type of frontend
@ -349,15 +351,15 @@ enum dmx_demux_caps {
/*
* Demux resource type identifier.
*/
/*
* DMX_FE_ENTRY(): Casts elements in the list of registered
* front-ends from the generic type struct list_head
* to the type * struct dmx_frontend
*.
*/
*/
/**
* DMX_FE_ENTRY - Casts elements in the list of registered
* front-ends from the generic type struct list_head
* to the type * struct dmx_frontend
*
* @list: list of struct dmx_frontend
*/
#define DMX_FE_ENTRY(list) \
list_entry(list, struct dmx_frontend, connectivity_list)
@ -551,7 +553,6 @@ enum dmx_demux_caps {
* 0 on success;
* -EINVAL on bad parameter.
*/
struct dmx_demux {
enum dmx_demux_caps capabilities;
struct dmx_frontend *frontend;
@ -581,11 +582,6 @@ struct dmx_demux {
int (*get_pes_pids)(struct dmx_demux *demux, u16 *pids);
/* private: Not used upstream and never documented */
#if 0
int (*get_caps)(struct dmx_demux *demux, struct dmx_caps *caps);
int (*set_source)(struct dmx_demux *demux, const dmx_source_t *src);
#endif
/*
* private: Only used at av7110, to read some data from firmware.
* As this was never documented, we have no clue about what's