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

media: fix incorrect kernel doc usages

This patch fixes the following trivial warnings w.r.t. kernel-doc usage:

drivers/media/common/videobuf2/frame_vector.c:38: warning: Excess function parameter 'gup_flags' description in 'get_vaddr_frames'
drivers/media/dvb-core/dvb_ca_en50221.c:193: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1014: warning: expecting prototype for Wake up the DVB CA thread(). Prototype was for
dvb_ca_en50221_thread_wakeup() instead
drivers/media/dvb-core/dvb_ca_en50221.c:1023: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1081: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1112: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1327: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1411: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1426: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1582: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1693: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1743: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1772: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1830: warning: wrong kernel-doc identifier on line:
drivers/media/dvb-core/dvb_ca_en50221.c:1922: warning: wrong kernel-doc identifier on line:
drivers/media/rc/img-ir/img-ir-hw.c:628: warning: expecting prototype for img_ir_decoder_compatable(). Prototype was for
img_ir_decoder_compatible() instead
drivers/media/v4l2-core/v4l2-jpeg.c:461: warning: expecting prototype for jpeg_parse_header(). Prototype was for v4l2_jpeg_parse_header()
instead
drivers/media/platform/vsp1/vsp1_dl.c:166: warning: expecting prototype for struct vsp1_cmd_pool. Prototype was for struct vsp1_dl_cmd_pool
instead
drivers/media/platform/mtk-vpu/mtk_vpu.c:28: warning: expecting prototype for is a tiny processor controlling video hardware(). Prototype
was for INIT_TIMEOUT_MS() instead
drivers/media/platform/mtk-vcodec/vdec/vdec_vp9_if.c:73: warning: expecting prototype for struct vp9_fb_info. Prototype was for struct
vp9_ref_buf instead
drivers/media/platform/mtk-vcodec/vdec/vdec_vp9_if.c:85: warning: expecting prototype for struct vp9_fb_info. Prototype was for struct
vp9_sf_ref_fb instead
drivers/media/tuners/mt2063.c:1404: warning: expecting prototype for fLO_FractionalTerm(). Prototype was for MT2063_fLO_FractionalTerm() instead
drivers/media/tuners/mt2063.c:1465: warning: expecting prototype for CalcLO2Mult(). Prototype was for MT2063_CalcLO2Mult() instead
drivers/media/usb/pwc/pwc-dec23.c:640: warning: wrong kernel-doc identifier on line:
drivers/media/platform/exynos4-is/media-dev.c:820: warning: expecting prototype for __fimc_md_create_fimc_links(). Prototype was for
__fimc_md_create_fimc_sink_links() instead
drivers/media/i2c/s5k6aa.c:426: warning: expecting prototype for s5k6aa_configure_pixel_clock(). Prototype was for
s5k6aa_configure_pixel_clocks() instead
drivers/media/i2c/imx274.c:700: warning: wrong kernel-doc identifier on line:
drivers/media/i2c/imx274.c:735: warning: wrong kernel-doc identifier on line:
drivers/media/i2c/imx274.c:983: warning: wrong kernel-doc identifier on line:

Most are missing or mistyped function names.

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
a4184b4f 5cde22fc

+34 -32
-1
drivers/media/common/videobuf2/frame_vector.c
··· 14 14 * get_vaddr_frames() - map virtual addresses to pfns 15 15 * @start: starting user address 16 16 * @nr_frames: number of pages / pfns from start to map 17 - * @gup_flags: flags modifying lookup behaviour 18 17 * @vec: structure which receives pages / pfns of the addresses mapped. 19 18 * It should have space for at least nr_frames entries. 20 19 *
+17 -15
drivers/media/dvb-core/dvb_ca_en50221.c
··· 190 190 u8 *ebuf, int ecount); 191 191 192 192 /** 193 - * Safely find needle in haystack. 193 + * findstr - Safely find needle in haystack. 194 194 * 195 195 * @haystack: Buffer to look in. 196 196 * @hlen: Number of bytes in haystack. ··· 1006 1006 /* EN50221 thread functions */ 1007 1007 1008 1008 /** 1009 - * Wake up the DVB CA thread 1009 + * dvb_ca_en50221_thread_wakeup - Wake up the DVB CA thread 1010 1010 * 1011 1011 * @ca: CA instance. 1012 1012 */ ··· 1020 1020 } 1021 1021 1022 1022 /** 1023 - * Update the delay used by the thread. 1023 + * dvb_ca_en50221_thread_update_delay - Update the delay used by the thread. 1024 1024 * 1025 1025 * @ca: CA instance. 1026 1026 */ ··· 1078 1078 } 1079 1079 1080 1080 /** 1081 - * Poll if the CAM is gone. 1081 + * dvb_ca_en50221_poll_cam_gone - Poll if the CAM is gone. 1082 1082 * 1083 1083 * @ca: CA instance. 1084 1084 * @slot: Slot to process. ··· 1109 1109 } 1110 1110 1111 1111 /** 1112 - * Thread state machine for one CA slot to perform the data transfer. 1112 + * dvb_ca_en50221_thread_state_machine - Thread state machine for one CA slot 1113 + * to perform the data transfer. 1113 1114 * 1114 1115 * @ca: CA instance. 1115 1116 * @slot: Slot to process. ··· 1325 1324 /* EN50221 IO interface functions */ 1326 1325 1327 1326 /** 1328 - * Real ioctl implementation. 1329 - * NOTE: CA_SEND_MSG/CA_GET_MSG ioctls have userspace buffers passed to them. 1327 + * dvb_ca_en50221_io_do_ioctl - Real ioctl implementation. 1330 1328 * 1331 1329 * @file: File concerned. 1332 1330 * @cmd: IOCTL command. 1333 1331 * @parg: Associated argument. 1332 + * 1333 + * NOTE: CA_SEND_MSG/CA_GET_MSG ioctls have userspace buffers passed to them. 1334 1334 * 1335 1335 * return: 0 on success, <0 on error. 1336 1336 */ ··· 1410 1408 } 1411 1409 1412 1410 /** 1413 - * Wrapper for ioctl implementation. 1411 + * dvb_ca_en50221_io_ioctl - Wrapper for ioctl implementation. 1414 1412 * 1415 1413 * @file: File concerned. 1416 1414 * @cmd: IOCTL command. ··· 1425 1423 } 1426 1424 1427 1425 /** 1428 - * Implementation of write() syscall. 1426 + * dvb_ca_en50221_io_write - Implementation of write() syscall. 1429 1427 * 1430 1428 * @file: File structure. 1431 1429 * @buf: Source buffer. ··· 1581 1579 } 1582 1580 1583 1581 /** 1584 - * Implementation of read() syscall. 1582 + * dvb_ca_en50221_io_read - Implementation of read() syscall. 1585 1583 * 1586 1584 * @file: File structure. 1587 1585 * @buf: Destination buffer. ··· 1692 1690 } 1693 1691 1694 1692 /** 1695 - * Implementation of file open syscall. 1693 + * dvb_ca_en50221_io_open - Implementation of file open syscall. 1696 1694 * 1697 1695 * @inode: Inode concerned. 1698 1696 * @file: File concerned. ··· 1742 1740 } 1743 1741 1744 1742 /** 1745 - * Implementation of file close syscall. 1743 + * dvb_ca_en50221_io_release - Implementation of file close syscall. 1746 1744 * 1747 1745 * @inode: Inode concerned. 1748 1746 * @file: File concerned. ··· 1771 1769 } 1772 1770 1773 1771 /** 1774 - * Implementation of poll() syscall. 1772 + * dvb_ca_en50221_io_poll - Implementation of poll() syscall. 1775 1773 * 1776 1774 * @file: File concerned. 1777 1775 * @wait: poll wait table. ··· 1829 1827 /* Initialisation/shutdown functions */ 1830 1828 1831 1829 /** 1832 - * Initialise a new DVB CA EN50221 interface device. 1830 + * dvb_ca_en50221_init - Initialise a new DVB CA EN50221 interface device. 1833 1831 * 1834 1832 * @dvb_adapter: DVB adapter to attach the new CA device to. 1835 1833 * @pubca: The dvb_ca instance. ··· 1921 1919 EXPORT_SYMBOL(dvb_ca_en50221_init); 1922 1920 1923 1921 /** 1924 - * Release a DVB CA EN50221 interface device. 1922 + * dvb_ca_en50221_release - Release a DVB CA EN50221 interface device. 1925 1923 * 1926 1924 * @pubca: The associated dvb_ca instance. 1927 1925 */
+4 -3
drivers/media/i2c/imx274.c
··· 697 697 } 698 698 699 699 /** 700 - * Read a multibyte register. 700 + * imx274_read_mbreg - Read a multibyte register. 701 701 * 702 702 * Uses a bulk read where possible. 703 703 * ··· 732 732 } 733 733 734 734 /** 735 - * Write a multibyte register. 735 + * imx274_write_mbreg - Write a multibyte register. 736 736 * 737 737 * Uses a bulk write where possible. 738 738 * ··· 980 980 } 981 981 982 982 /** 983 - * Helper function to change binning and set both compose and format. 983 + * __imx274_change_compose - Helper function to change binning and set both 984 + * compose and format. 984 985 * 985 986 * We have two entry points to change binning: set_fmt and 986 987 * set_selection(COMPOSE). Both have to compute the new output size
+1 -1
drivers/media/i2c/s5k6aa.c
··· 416 416 } 417 417 418 418 /** 419 - * s5k6aa_configure_pixel_clock - apply ISP main clock/PLL configuration 419 + * s5k6aa_configure_pixel_clocks - apply ISP main clock/PLL configuration 420 420 * @s5k6aa: pointer to &struct s5k6aa describing the device 421 421 * 422 422 * Configure the internal ISP PLL for the required output frequency.
+1 -1
drivers/media/platform/exynos4-is/media-dev.c
··· 806 806 } 807 807 808 808 /** 809 - * __fimc_md_create_fimc_links - create links to all FIMC entities 809 + * __fimc_md_create_fimc_sink_links - create links to all FIMC entities 810 810 * @fmd: fimc media device 811 811 * @source: the source entity to create links to all fimc entities from 812 812 * @sensor: sensor subdev linked to FIMC[fimc_id] entity, may be null
+2 -2
drivers/media/platform/mtk-vcodec/vdec/vdec_vp9_if.c
··· 61 61 }; 62 62 63 63 /** 64 - * struct vp9_fb_info - contains current frame's reference buffer information 64 + * struct vp9_ref_buf - contains current frame's reference buffer information 65 65 * @buf : reference buffer 66 66 * @idx : reference buffer index to frm_bufs 67 67 * @reserved : reserved field used by vpu ··· 73 73 }; 74 74 75 75 /** 76 - * struct vp9_fb_info - contains frame buffer info 76 + * struct vp9_sf_ref_fb - contains frame buffer info 77 77 * @fb : super frame reference frame buffer 78 78 * @used : this reference frame info entry is used 79 79 * @padding : for 64 bytes size align
+2 -2
drivers/media/platform/mtk-vpu/mtk_vpu.c
··· 19 19 20 20 #include "mtk_vpu.h" 21 21 22 - /** 22 + /* 23 23 * VPU (video processor unit) is a tiny processor controlling video hardware 24 24 * related to video codec, scaling and color format converting. 25 25 * VPU interfaces with other blocks by share memory and interrupt. 26 - **/ 26 + */ 27 27 28 28 #define INIT_TIMEOUT_MS 2000U 29 29 #define IPI_TIMEOUT_MS 2000U
+1 -1
drivers/media/platform/vsp1/vsp1_dl.c
··· 142 142 }; 143 143 144 144 /** 145 - * struct vsp1_cmd_pool - Display List commands pool 145 + * struct vsp1_dl_cmd_pool - Display List commands pool 146 146 * @dma: DMA address of the entries 147 147 * @size: size of the full DMA memory pool in bytes 148 148 * @mem: CPU memory pointer for the pool
+1 -1
drivers/media/rc/img-ir/img-ir-hw.c
··· 617 617 } 618 618 619 619 /** 620 - * img_ir_decoder_compatable() - Find whether a decoder will work with a device. 620 + * img_ir_decoder_compatible() - Find whether a decoder will work with a device. 621 621 * @priv: IR private data. 622 622 * @dec: Decoder to check. 623 623 *
+3 -3
drivers/media/tuners/mt2063.c
··· 1383 1383 } 1384 1384 1385 1385 /** 1386 - * fLO_FractionalTerm() - Calculates the portion contributed by FracN / denom. 1386 + * MT2063_fLO_FractionalTerm - Calculates the portion contributed by FracN / denom. 1387 1387 * This function preserves maximum precision without 1388 1388 * risk of overflow. It accurately calculates 1389 1389 * f_ref * num / denom to within 1 HZ with fixed math. ··· 1411 1411 } 1412 1412 1413 1413 /* 1414 - * CalcLO1Mult()- Calculates Integer divider value and the numerator 1414 + * MT2063_CalcLO1Mult - Calculates Integer divider value and the numerator 1415 1415 * value for a FracN PLL. 1416 1416 * 1417 1417 * This function assumes that the f_LO and f_Ref are ··· 1444 1444 } 1445 1445 1446 1446 /** 1447 - * CalcLO2Mult() - Calculates Integer divider value and the numerator 1447 + * MT2063_CalcLO2Mult - Calculates Integer divider value and the numerator 1448 1448 * value for a FracN PLL. 1449 1449 * 1450 1450 * This function assumes that the f_LO and f_Ref are
+1 -1
drivers/media/usb/pwc/pwc-dec23.c
··· 637 637 } 638 638 639 639 /** 640 - * Uncompress a pwc23 buffer. 640 + * pwc_dec23_decompress - Uncompress a pwc23 buffer. 641 641 * @pdev: pointer to pwc device's internal struct 642 642 * @src: raw data 643 643 * @dst: image output
+1 -1
drivers/media/v4l2-core/v4l2-jpeg.c
··· 445 445 } 446 446 447 447 /** 448 - * jpeg_parse_header - locate marker segments and optionally parse headers 448 + * v4l2_jpeg_parse_header - locate marker segments and optionally parse headers 449 449 * @buf: address of the JPEG buffer, should start with a SOI marker 450 450 * @len: length of the JPEG buffer 451 451 * @out: returns marker segment positions and optionally parsed headers