提交 4f1c1868 编写于 作者: M Mauro Carvalho Chehab

[media] DocBook: add dvb_frontend.h to documentation

There are already some comments at dvb_frontend.h that are ready
for DocBook, although not properly formatted.

Convert them, and add this file to the device-drivers DocBook.
Signed-off-by: NMauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: NJonathan Corbet <corbet@lwn.net>
上级 fbefb1a8
...@@ -228,6 +228,7 @@ X!Isound/sound_firmware.c ...@@ -228,6 +228,7 @@ X!Isound/sound_firmware.c
!Iinclude/media/v4l2-subdev.h !Iinclude/media/v4l2-subdev.h
!Iinclude/media/rc-core.h !Iinclude/media/rc-core.h
!Idrivers/media/dvb-core/dvb_ca_en50221.h !Idrivers/media/dvb-core/dvb_ca_en50221.h
!Idrivers/media/dvb-core/dvb_frontend.h
<!-- FIXME: Removed for now due to document generation inconsistency <!-- FIXME: Removed for now due to document generation inconsistency
X!Iinclude/media/v4l2-ctrls.h X!Iinclude/media/v4l2-ctrls.h
X!Iinclude/media/v4l2-dv-timings.h X!Iinclude/media/v4l2-dv-timings.h
...@@ -237,7 +238,6 @@ X!Iinclude/media/videobuf2-memops.h ...@@ -237,7 +238,6 @@ X!Iinclude/media/videobuf2-memops.h
X!Iinclude/media/videobuf2-core.h X!Iinclude/media/videobuf2-core.h
X!Iinclude/media/lirc.h X!Iinclude/media/lirc.h
X!Edrivers/media/dvb-core/dvb_demux.c X!Edrivers/media/dvb-core/dvb_demux.c
X!Idrivers/media/dvb-core/dvb_frontend.h
X!Idrivers/media/dvb-core/dvbdev.h X!Idrivers/media/dvb-core/dvbdev.h
X!Edrivers/media/dvb-core/dvb_net.c X!Edrivers/media/dvb-core/dvb_net.c
X!Idrivers/media/dvb-core/dvb_ringbuffer.h X!Idrivers/media/dvb-core/dvb_ringbuffer.h
......
...@@ -121,30 +121,28 @@ enum tuner_param { ...@@ -121,30 +121,28 @@ enum tuner_param {
DVBFE_TUNER_DUMMY = (1 << 31) DVBFE_TUNER_DUMMY = (1 << 31)
}; };
/* /**
* ALGO_HW: (Hardware Algorithm) * enum dvbfe_algo - defines the algorithm used to tune into a channel
* ---------------------------------------------------------------- *
* Devices that support this algorithm do everything in hardware * @DVBFE_ALGO_HW: (Hardware Algorithm)
* and no software support is needed to handle them. * Devices that support this algorithm do everything in hardware
* Requesting these devices to LOCK is the only thing required, * and no software support is needed to handle them.
* device is supposed to do everything in the hardware. * Requesting these devices to LOCK is the only thing required,
* device is supposed to do everything in the hardware.
* *
* ALGO_SW: (Software Algorithm) * @DVBFE_ALGO_SW: (Software Algorithm)
* ----------------------------------------------------------------
* These are dumb devices, that require software to do everything * These are dumb devices, that require software to do everything
* *
* ALGO_CUSTOM: (Customizable Agorithm) * @DVBFE_ALGO_CUSTOM: (Customizable Agorithm)
* ---------------------------------------------------------------- * Devices having this algorithm can be customized to have specific
* Devices having this algorithm can be customized to have specific * algorithms in the frontend driver, rather than simply doing a
* algorithms in the frontend driver, rather than simply doing a * software zig-zag. In this case the zigzag maybe hardware assisted
* software zig-zag. In this case the zigzag maybe hardware assisted * or it maybe completely done in hardware. In all cases, usage of
* or it maybe completely done in hardware. In all cases, usage of * this algorithm, in conjunction with the search and track
* this algorithm, in conjunction with the search and track * callbacks, utilizes the driver specific algorithm.
* callbacks, utilizes the driver specific algorithm.
* *
* ALGO_RECOVERY: (Recovery Algorithm) * @DVBFE_ALGO_RECOVERY: (Recovery Algorithm)
* ---------------------------------------------------------------- * These devices have AUTO recovery capabilities from LOCK failure
* These devices have AUTO recovery capabilities from LOCK failure
*/ */
enum dvbfe_algo { enum dvbfe_algo {
DVBFE_ALGO_HW = (1 << 0), DVBFE_ALGO_HW = (1 << 0),
...@@ -162,27 +160,27 @@ struct tuner_state { ...@@ -162,27 +160,27 @@ struct tuner_state {
u32 refclock; u32 refclock;
}; };
/* /**
* search callback possible return status * enum dvbfe_search - search callback possible return status
* *
* DVBFE_ALGO_SEARCH_SUCCESS * @DVBFE_ALGO_SEARCH_SUCCESS:
* The frontend search algorithm completed and returned successfully * The frontend search algorithm completed and returned successfully
* *
* DVBFE_ALGO_SEARCH_ASLEEP * @DVBFE_ALGO_SEARCH_ASLEEP:
* The frontend search algorithm is sleeping * The frontend search algorithm is sleeping
* *
* DVBFE_ALGO_SEARCH_FAILED * @DVBFE_ALGO_SEARCH_FAILED:
* The frontend search for a signal failed * The frontend search for a signal failed
* *
* DVBFE_ALGO_SEARCH_INVALID * @DVBFE_ALGO_SEARCH_INVALID:
* The frontend search algorith was probably supplied with invalid * The frontend search algorith was probably supplied with invalid
* parameters and the search is an invalid one * parameters and the search is an invalid one
* *
* DVBFE_ALGO_SEARCH_ERROR * @DVBFE_ALGO_SEARCH_ERROR:
* The frontend search algorithm failed due to some error * The frontend search algorithm failed due to some error
* *
* DVBFE_ALGO_SEARCH_AGAIN * @DVBFE_ALGO_SEARCH_AGAIN:
* The frontend search algorithm was requested to search again * The frontend search algorithm was requested to search again
*/ */
enum dvbfe_search { enum dvbfe_search {
DVBFE_ALGO_SEARCH_SUCCESS = (1 << 0), DVBFE_ALGO_SEARCH_SUCCESS = (1 << 0),
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册