summaryrefslogtreecommitdiff
path: root/include/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-21 16:36:54 +0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-12-18 17:06:40 +0300
commit8030e774e209bca8504e7b73e186afe8e83e1532 (patch)
tree8da5d398f87393472c9d1cadd07e5c2e363f3ca8 /include/media
parent0bd9298557eefbf63d169cc8f853fa3f21078cab (diff)
downloadlinux-8030e774e209bca8504e7b73e186afe8e83e1532.tar.xz
media: tuner-types: add kernel-doc markups for struct tunertype
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>
Diffstat (limited to 'include/media')
-rw-r--r--include/media/tuner-types.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/include/media/tuner-types.h b/include/media/tuner-types.h
index 78f0654d9c3d..df76ac8e658c 100644
--- a/include/media/tuner-types.h
+++ b/include/media/tuner-types.h
@@ -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;