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

[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: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>

+34 -36
+1 -1
Documentation/DocBook/device-drivers.tmpl
··· 228 228 !Iinclude/media/v4l2-subdev.h 229 229 !Iinclude/media/rc-core.h 230 230 !Idrivers/media/dvb-core/dvb_ca_en50221.h 231 + !Idrivers/media/dvb-core/dvb_frontend.h 231 232 <!-- FIXME: Removed for now due to document generation inconsistency 232 233 X!Iinclude/media/v4l2-ctrls.h 233 234 X!Iinclude/media/v4l2-dv-timings.h ··· 238 237 X!Iinclude/media/videobuf2-core.h 239 238 X!Iinclude/media/lirc.h 240 239 X!Edrivers/media/dvb-core/dvb_demux.c 241 - X!Idrivers/media/dvb-core/dvb_frontend.h 242 240 X!Idrivers/media/dvb-core/dvbdev.h 243 241 X!Edrivers/media/dvb-core/dvb_net.c 244 242 X!Idrivers/media/dvb-core/dvb_ringbuffer.h
+33 -35
drivers/media/dvb-core/dvb_frontend.h
··· 121 121 DVBFE_TUNER_DUMMY = (1 << 31) 122 122 }; 123 123 124 - /* 125 - * ALGO_HW: (Hardware Algorithm) 126 - * ---------------------------------------------------------------- 127 - * Devices that support this algorithm do everything in hardware 128 - * and no software support is needed to handle them. 129 - * Requesting these devices to LOCK is the only thing required, 130 - * device is supposed to do everything in the hardware. 124 + /** 125 + * enum dvbfe_algo - defines the algorithm used to tune into a channel 131 126 * 132 - * ALGO_SW: (Software Algorithm) 133 - * ---------------------------------------------------------------- 127 + * @DVBFE_ALGO_HW: (Hardware Algorithm) 128 + * Devices that support this algorithm do everything in hardware 129 + * and no software support is needed to handle them. 130 + * Requesting these devices to LOCK is the only thing required, 131 + * device is supposed to do everything in the hardware. 132 + * 133 + * @DVBFE_ALGO_SW: (Software Algorithm) 134 134 * These are dumb devices, that require software to do everything 135 135 * 136 - * ALGO_CUSTOM: (Customizable Agorithm) 137 - * ---------------------------------------------------------------- 138 - * Devices having this algorithm can be customized to have specific 139 - * algorithms in the frontend driver, rather than simply doing a 140 - * software zig-zag. In this case the zigzag maybe hardware assisted 141 - * or it maybe completely done in hardware. In all cases, usage of 142 - * this algorithm, in conjunction with the search and track 143 - * callbacks, utilizes the driver specific algorithm. 136 + * @DVBFE_ALGO_CUSTOM: (Customizable Agorithm) 137 + * Devices having this algorithm can be customized to have specific 138 + * algorithms in the frontend driver, rather than simply doing a 139 + * software zig-zag. In this case the zigzag maybe hardware assisted 140 + * or it maybe completely done in hardware. In all cases, usage of 141 + * this algorithm, in conjunction with the search and track 142 + * callbacks, utilizes the driver specific algorithm. 144 143 * 145 - * ALGO_RECOVERY: (Recovery Algorithm) 146 - * ---------------------------------------------------------------- 147 - * These devices have AUTO recovery capabilities from LOCK failure 144 + * @DVBFE_ALGO_RECOVERY: (Recovery Algorithm) 145 + * These devices have AUTO recovery capabilities from LOCK failure 148 146 */ 149 147 enum dvbfe_algo { 150 148 DVBFE_ALGO_HW = (1 << 0), ··· 160 162 u32 refclock; 161 163 }; 162 164 163 - /* 164 - * search callback possible return status 165 + /** 166 + * enum dvbfe_search - search callback possible return status 165 167 * 166 - * DVBFE_ALGO_SEARCH_SUCCESS 167 - * The frontend search algorithm completed and returned successfully 168 + * @DVBFE_ALGO_SEARCH_SUCCESS: 169 + * The frontend search algorithm completed and returned successfully 168 170 * 169 - * DVBFE_ALGO_SEARCH_ASLEEP 170 - * The frontend search algorithm is sleeping 171 + * @DVBFE_ALGO_SEARCH_ASLEEP: 172 + * The frontend search algorithm is sleeping 171 173 * 172 - * DVBFE_ALGO_SEARCH_FAILED 173 - * The frontend search for a signal failed 174 + * @DVBFE_ALGO_SEARCH_FAILED: 175 + * The frontend search for a signal failed 174 176 * 175 - * DVBFE_ALGO_SEARCH_INVALID 176 - * The frontend search algorith was probably supplied with invalid 177 - * parameters and the search is an invalid one 177 + * @DVBFE_ALGO_SEARCH_INVALID: 178 + * The frontend search algorith was probably supplied with invalid 179 + * parameters and the search is an invalid one 178 180 * 179 - * DVBFE_ALGO_SEARCH_ERROR 180 - * The frontend search algorithm failed due to some error 181 + * @DVBFE_ALGO_SEARCH_ERROR: 182 + * The frontend search algorithm failed due to some error 181 183 * 182 - * DVBFE_ALGO_SEARCH_AGAIN 183 - * The frontend search algorithm was requested to search again 184 + * @DVBFE_ALGO_SEARCH_AGAIN: 185 + * The frontend search algorithm was requested to search again 184 186 */ 185 187 enum dvbfe_search { 186 188 DVBFE_ALGO_SEARCH_SUCCESS = (1 << 0),