Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] dvb_frontend.h: document struct analog_demod_ops

Add documentation for struct analog_demod_info and
struct analog_demod_ops.

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

+27
+27
drivers/media/dvb-core/dvb_frontend.h
··· 282 282 int (*get_state)(struct dvb_frontend *fe, enum tuner_param param, struct tuner_state *state); 283 283 }; 284 284 285 + /** 286 + * struct analog_demod_info - Information struct for analog TV part of the demod 287 + * 288 + * @name: Name of the analog TV demodulator 289 + */ 285 290 struct analog_demod_info { 286 291 char *name; 287 292 }; 288 293 294 + /** 295 + * struct analog_demod_ops - Demodulation information and callbacks for 296 + * analog TV and radio 297 + * 298 + * @info: pointer to struct analog_demod_info 299 + * @set_params: callback function used to inform the demod to set the 300 + * demodulator parameters needed to decode an analog or 301 + * radio channel. The properties are passed via 302 + * struct @analog_params;. 303 + * @has_signal: returns 0xffff if has signal, or 0 if it doesn't. 304 + * @get_afc: Used only by analog TV core. Reports the frequency 305 + * drift due to AFC. 306 + * @tuner_status: callback function that returns tuner status bits, e. g. 307 + * TUNER_STATUS_LOCKED and TUNER_STATUS_STEREO. 308 + * @standby: set the tuner to standby mode. 309 + * @release: callback function called when frontend is dettached. 310 + * drivers should free any allocated memory. 311 + * @i2c_gate_ctrl: controls the I2C gate. Newer drivers should use I2C 312 + * mux support instead. 313 + * @set_config: callback function used to send some tuner-specific 314 + * parameters. 315 + */ 289 316 struct analog_demod_ops { 290 317 291 318 struct analog_demod_info info;