From: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Date: Sat, 22 Aug 2015 12:47:04 +0000 (-0300)
Subject: [media] dvb_frontend: document dvb_frontend_tune_settings
X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=b9de1726b52d0c1dc07d90fd6a63fca49ea8b5b9;p=linux-beck.git

[media] dvb_frontend: document dvb_frontend_tune_settings

Add Documentation for dvb_frontend_tune_settings struct.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
---

diff --git a/drivers/media/dvb-core/dvb_frontend.h b/drivers/media/dvb-core/dvb_frontend.h
index d20d3da97201..ea68ba61f0de 100644
--- a/drivers/media/dvb-core/dvb_frontend.h
+++ b/drivers/media/dvb-core/dvb_frontend.h
@@ -48,6 +48,15 @@
  */
 #define MAX_DELSYS	8
 
+/**
+ * struct dvb_frontend_tune_settings - parameters to adjust frontend tuning
+ *
+ * @min_delay_ms:	minimum delay for tuning, in ms
+ * @step_size:		step size between two consecutive frequencies
+ * @max_drift:		maximum drift
+ *
+ * NOTE: step_size is in Hz, for terrestrial/cable or kHz for satellite
+ */
 struct dvb_frontend_tune_settings {
 	int min_delay_ms;
 	int step_size;