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

media: core headers: fix kernel-doc warnings

This patch fixes the following kernel-doc warnings:

include/uapi/linux/videodev2.h:996: warning: Function parameter or member 'm' not described in 'v4l2_plane'
include/uapi/linux/videodev2.h:996: warning: Function parameter or member 'reserved' not described in 'v4l2_plane'
include/uapi/linux/videodev2.h:1057: warning: Function parameter or member 'm' not described in 'v4l2_buffer'
include/uapi/linux/videodev2.h:1057: warning: Function parameter or member 'reserved2' not described in 'v4l2_buffer'
include/uapi/linux/videodev2.h:1057: warning: Function parameter or member 'reserved' not described in 'v4l2_buffer'
include/uapi/linux/videodev2.h:1068: warning: Function parameter or member 'tv' not described in 'v4l2_timeval_to_ns'
include/uapi/linux/videodev2.h:1068: warning: Excess function parameter 'ts' description in 'v4l2_timeval_to_ns'
include/uapi/linux/videodev2.h:1138: warning: Function parameter or member 'reserved' not described in 'v4l2_exportbuffer'
include/uapi/linux/videodev2.h:2237: warning: Function parameter or member 'reserved' not described in 'v4l2_plane_pix_format'
include/uapi/linux/videodev2.h:2270: warning: Function parameter or member 'hsv_enc' not described in 'v4l2_pix_format_mplane'
include/uapi/linux/videodev2.h:2270: warning: Function parameter or member 'reserved' not described in 'v4l2_pix_format_mplane'
include/uapi/linux/videodev2.h:2281: warning: Function parameter or member 'reserved' not described in 'v4l2_sdr_format'
include/uapi/linux/videodev2.h:2315: warning: Function parameter or member 'fmt' not described in 'v4l2_format'

include/uapi/linux/v4l2-subdev.h:53: warning: Function parameter or member 'reserved' not described in 'v4l2_subdev_format'
include/uapi/linux/v4l2-subdev.h:66: warning: Function parameter or member 'reserved' not described in 'v4l2_subdev_crop'
include/uapi/linux/v4l2-subdev.h:89: warning: Function parameter or member 'reserved' not described in 'v4l2_subdev_mbus_code_enum'
include/uapi/linux/v4l2-subdev.h:108: warning: Function parameter or member 'min_width' not described in 'v4l2_subdev_frame_size_enum'
include/uapi/linux/v4l2-subdev.h:108: warning: Function parameter or member 'max_width' not described in 'v4l2_subdev_frame_size_enum'
include/uapi/linux/v4l2-subdev.h:108: warning: Function parameter or member 'min_height' not described in 'v4l2_subdev_frame_size_enum'
include/uapi/linux/v4l2-subdev.h:108: warning: Function parameter or member 'max_height' not described in 'v4l2_subdev_frame_size_enum'
include/uapi/linux/v4l2-subdev.h:108: warning: Function parameter or member 'reserved' not described in 'v4l2_subdev_frame_size_enum'
include/uapi/linux/v4l2-subdev.h:119: warning: Function parameter or member 'reserved' not described in 'v4l2_subdev_frame_interval'
include/uapi/linux/v4l2-subdev.h:140: warning: Function parameter or member 'reserved' not described in 'v4l2_subdev_frame_interval_enum'

include/uapi/linux/cec.h:406: warning: Function parameter or member 'raw' not described in 'cec_connector_info'
include/uapi/linux/cec.h:470: warning: Function parameter or member 'flags' not described in 'cec_event'

include/media/v4l2-h264.h:82: warning: Function parameter or member 'reflist' not described in 'v4l2_h264_build_p_ref_list'
include/media/v4l2-h264.h:82: warning: expecting prototype for v4l2_h264_build_b_ref_lists(). Prototype was for v4l2_h264_build_p_ref_list()
instead

include/media/cec.h:50: warning: Function parameter or member 'lock' not described in 'cec_devnode'

include/media/v4l2-jpeg.h:122: warning: Function parameter or member 'num_dht' not described in 'v4l2_jpeg_header'
include/media/v4l2-jpeg.h:122: warning: Function parameter or member 'num_dqt' not described in 'v4l2_jpeg_header'

Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab
f12b81e4 f550eca5

+33 -7
+1 -1
include/media/cec.h
··· 28 28 * @minor: device node minor number 29 29 * @registered: the device was correctly registered 30 30 * @unregistered: the device was unregistered 31 - * @fhs_lock: lock to control access to the filehandle list 32 31 * @fhs: the list of open filehandles (cec_fh) 32 + * @lock: lock to control access to this structure 33 33 * 34 34 * This structure represents a cec-related device node. 35 35 *
+3 -3
include/media/v4l2-h264.h
··· 66 66 u8 *b0_reflist, u8 *b1_reflist); 67 67 68 68 /** 69 - * v4l2_h264_build_b_ref_lists() - Build the P reference list 69 + * v4l2_h264_build_p_ref_list() - Build the P reference list 70 70 * 71 71 * @builder: reference list builder context 72 - * @p_reflist: 16-bytes array used to store the P reference list. Each entry 73 - * is an index in the DPB 72 + * @reflist: 16-bytes array used to store the P reference list. Each entry 73 + * is an index in the DPB 74 74 * 75 75 * This functions builds the P reference lists. This procedure is describe in 76 76 * section '8.2.4 Decoding process for reference picture lists construction'
+2
include/media/v4l2-jpeg.h
··· 91 91 * struct v4l2_jpeg_header - parsed JPEG header 92 92 * @sof: pointer to frame header and size 93 93 * @sos: pointer to scan header and size 94 + * @num_dht: number of entries in @dht 94 95 * @dht: pointers to huffman tables and sizes 96 + * @num_dqt: number of entries in @dqt 95 97 * @dqt: pointers to quantization tables and sizes 96 98 * @frame: parsed frame header 97 99 * @scan: pointer to parsed scan header, optional
+2 -1
include/uapi/linux/cec.h
··· 396 396 * associated with the CEC adapter. 397 397 * @type: connector type (if any) 398 398 * @drm: drm connector info 399 + * @raw: array to pad the union 399 400 */ 400 401 struct cec_connector_info { 401 402 __u32 type; ··· 454 453 * struct cec_event - CEC event structure 455 454 * @ts: the timestamp of when the event was sent. 456 455 * @event: the event. 457 - * array. 456 + * @flags: event flags. 458 457 * @state_change: the event payload for CEC_EVENT_STATE_CHANGE. 459 458 * @lost_msgs: the event payload for CEC_EVENT_LOST_MSGS. 460 459 * @raw: array to pad the union.
+11 -1
include/uapi/linux/v4l2-subdev.h
··· 44 44 * @which: format type (from enum v4l2_subdev_format_whence) 45 45 * @pad: pad number, as reported by the media API 46 46 * @format: media bus format (format code and frame size) 47 + * @reserved: drivers and applications must zero this array 47 48 */ 48 49 struct v4l2_subdev_format { 49 50 __u32 which; ··· 58 57 * @which: format type (from enum v4l2_subdev_format_whence) 59 58 * @pad: pad number, as reported by the media API 60 59 * @rect: pad crop rectangle boundaries 60 + * @reserved: drivers and applications must zero this array 61 61 */ 62 62 struct v4l2_subdev_crop { 63 63 __u32 which; ··· 80 78 * @code: format code (MEDIA_BUS_FMT_ definitions) 81 79 * @which: format type (from enum v4l2_subdev_format_whence) 82 80 * @flags: flags set by the driver, (V4L2_SUBDEV_MBUS_CODE_*) 81 + * @reserved: drivers and applications must zero this array 83 82 */ 84 83 struct v4l2_subdev_mbus_code_enum { 85 84 __u32 pad; ··· 93 90 94 91 /** 95 92 * struct v4l2_subdev_frame_size_enum - Media bus format enumeration 96 - * @pad: pad number, as reported by the media API 97 93 * @index: format index during enumeration 94 + * @pad: pad number, as reported by the media API 98 95 * @code: format code (MEDIA_BUS_FMT_ definitions) 96 + * @min_width: minimum frame width, in pixels 97 + * @max_width: maximum frame width, in pixels 98 + * @min_height: minimum frame height, in pixels 99 + * @max_height: maximum frame height, in pixels 99 100 * @which: format type (from enum v4l2_subdev_format_whence) 101 + * @reserved: drivers and applications must zero this array 100 102 */ 101 103 struct v4l2_subdev_frame_size_enum { 102 104 __u32 index; ··· 119 111 * struct v4l2_subdev_frame_interval - Pad-level frame rate 120 112 * @pad: pad number, as reported by the media API 121 113 * @interval: frame interval in seconds 114 + * @reserved: drivers and applications must zero this array 122 115 */ 123 116 struct v4l2_subdev_frame_interval { 124 117 __u32 pad; ··· 136 127 * @height: frame height in pixels 137 128 * @interval: frame interval in seconds 138 129 * @which: format type (from enum v4l2_subdev_format_whence) 130 + * @reserved: drivers and applications must zero this array 139 131 */ 140 132 struct v4l2_subdev_frame_interval_enum { 141 133 __u32 index;
+14 -1
include/uapi/linux/videodev2.h
··· 976 976 * pointing to this plane 977 977 * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file 978 978 * descriptor associated with this plane 979 + * @m: union of @mem_offset, @userptr and @fd 979 980 * @data_offset: offset in the plane to the start of data; usually 0, 980 981 * unless there is a header in front of the data 982 + * @reserved: drivers and applications must zero this array 981 983 * 982 984 * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer 983 985 * with two planes can have one plane for Y, and another for interleaved CbCr ··· 1021 1019 * a userspace file descriptor associated with this buffer 1022 1020 * @planes: for multiplanar buffers; userspace pointer to the array of plane 1023 1021 * info structs for this buffer 1022 + * @m: union of @offset, @userptr, @planes and @fd 1024 1023 * @length: size in bytes of the buffer (NOT its payload) for single-plane 1025 1024 * buffers (when type != *_MPLANE); number of elements in the 1026 1025 * planes array for multi-plane buffers 1026 + * @reserved2: drivers and applications must zero this field 1027 1027 * @request_fd: fd of the request that this buffer should use 1028 + * @reserved: for backwards compatibility with applications that do not know 1029 + * about @request_fd 1028 1030 * 1029 1031 * Contains data exchanged by application and driver using one of the Streaming 1030 1032 * I/O methods. ··· 1066 1060 #ifndef __KERNEL__ 1067 1061 /** 1068 1062 * v4l2_timeval_to_ns - Convert timeval to nanoseconds 1069 - * @ts: pointer to the timeval variable to be converted 1063 + * @tv: pointer to the timeval variable to be converted 1070 1064 * 1071 1065 * Returns the scalar nanosecond representation of the timeval 1072 1066 * parameter. ··· 1127 1121 * @flags: flags for newly created file, currently only O_CLOEXEC is 1128 1122 * supported, refer to manual of open syscall for more details 1129 1123 * @fd: file descriptor associated with DMABUF (set by driver) 1124 + * @reserved: drivers and applications must zero this array 1130 1125 * 1131 1126 * Contains data used for exporting a video buffer as DMABUF file descriptor. 1132 1127 * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF ··· 2240 2233 * this plane will be used 2241 2234 * @bytesperline: distance in bytes between the leftmost pixels in two 2242 2235 * adjacent lines 2236 + * @reserved: drivers and applications must zero this array 2243 2237 */ 2244 2238 struct v4l2_plane_pix_format { 2245 2239 __u32 sizeimage; ··· 2259 2251 * @num_planes: number of planes for this format 2260 2252 * @flags: format flags (V4L2_PIX_FMT_FLAG_*) 2261 2253 * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding 2254 + * @hsv_enc: enum v4l2_hsv_encoding, HSV encoding 2262 2255 * @quantization: enum v4l2_quantization, colorspace quantization 2263 2256 * @xfer_func: enum v4l2_xfer_func, colorspace transfer function 2257 + * @reserved: drivers and applications must zero this array 2264 2258 */ 2265 2259 struct v4l2_pix_format_mplane { 2266 2260 __u32 width; ··· 2287 2277 * struct v4l2_sdr_format - SDR format definition 2288 2278 * @pixelformat: little endian four character code (fourcc) 2289 2279 * @buffersize: maximum size in bytes required for data 2280 + * @reserved: drivers and applications must zero this array 2290 2281 */ 2291 2282 struct v4l2_sdr_format { 2292 2283 __u32 pixelformat; ··· 2314 2303 * @vbi: raw VBI capture or output parameters 2315 2304 * @sliced: sliced VBI capture or output parameters 2316 2305 * @raw_data: placeholder for future extensions and custom formats 2306 + * @fmt: union of @pix, @pix_mp, @win, @vbi, @sliced, @sdr, @meta 2307 + * and @raw_data 2317 2308 */ 2318 2309 struct v4l2_format { 2319 2310 __u32 type;