Kernel/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-12-28 16:56:26 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

media: tuner-types: add kernel-doc markups for struct tunertype

Browse Source 
This struct is lacking documentation. Add it.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2017-09-21 09:36:54 -04:00
parent 0bd9298557
commit 8030e774e2
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/media/tuner-types.h
View File

@ -171,6 +171,21 @@ struct tuner_params {
struct tuner_range *ranges;
};
/**
* struct tunertype - describes the known tuners.
*
* @name: string with the tuner's name.
* @count: size of &struct tuner_params array.
* @params: pointer to &struct tuner_params array.
*
* @min: minimal tuner frequency, in 62.5 kHz step.
* should be multiplied to 16 to convert to MHz.
* @max: minimal tuner frequency, in 62.5 kHz step.
* Should be multiplied to 16 to convert to MHz.
* @stepsize: frequency step, in Hz.
* @initdata: optional byte sequence to initialize the tuner.
* @sleepdata: optional byte sequence to power down the tuner.
*/
struct tunertype {
char *name;
unsigned int count;