forked from Minki/linux
e383ce0736
As warned by linuxdoc[1] tool, using:
$ for i in $(git grep kernel-doc Documentation/media/kapi/|cut -d: -f4); do kernel-lintdoc --sloppy $i; done
include/media/v4l2-dev.h:118 :WARN: function name from comment differs: v4l2_prio_close <--> v4l2_prio_check
include/media/v4l2-mc.h:56 [kernel-doc WARN] : enum name from comment differs: if_vid_dec_index <--> if_vid_dec_pad_index
include/media/v4l2-mc.h:71 [kernel-doc WARN] : enum name from comment differs: if_aud_dec_index <--> if_aud_dec_pad_index
include/media/v4l2-mem2mem.h:396 [kernel-doc WARN] : function name from comment differs: v4l2_m2m_num_src_bufs_ready <--> v4l2_m2m_num_dst_bufs_ready
drivers/media/dvb-core/dvb_math.h:28 [kernel-doc WARN] : function name from comment differs: cintlog2 <--> intlog2
include/media/v4l2-subdev.h:215 [kernel-doc WARN] : struct name from comment differs: s_radio <--> v4l2_subdev_tuner_ops
include/media/v4l2-subdev.h:890 [kernel-doc WARN] : function name from comment differs: v4l2_set_subdevdata <--> v4l2_set_subdev_hostdata
include/media/v4l2-subdev.h:901 [kernel-doc WARN] : function name from comment differs: v4l2_get_subdevdata <--> v4l2_get_subdev_hostdata
drivers/media/dvb-core/dvb_ringbuffer.h:196 [kernel-doc WARN] : function name from comment differs: dvb_ringbuffer_writeuser <--> dvb_ringbuffer_write_user
include/media/videobuf2-core.h:399 [kernel-doc WARN] : struct name from comment differs: vb2_ops <--> vb2_buf_ops
include/media/media-entity.h:132 [kernel-doc ERROR] : duplicate parameter definition 'source'
include/media/media-entity.h:477 [kernel-doc WARN] : function name from comment differs: media_entity_enum_test <--> media_entity_enum_test_and_set
include/media/media-entity.h:535 [kernel-doc WARN] : function name from comment differs: gobj_to_entity <--> gobj_to_pad
include/media/media-entity.h:544 [kernel-doc WARN] : function name from comment differs: gobj_to_entity <--> gobj_to_link
include/media/media-entity.h:553 [kernel-doc WARN] : function name from comment differs: gobj_to_entity <--> gobj_to_intf
include/media/media-entity.h:562 [kernel-doc WARN] : function name from comment differs: gobj_to_entity <--> intf_to_devnode
include/media/rc-core.h:234 [kernel-doc WARN] : function name from comment differs: rc_open <--> rc_close
include/media/v4l2-ctrls.h:397 [kernel-doc WARN] : missing initial short description of 'v4l2_ctrl_handler_init'
include/media/v4l2-dev.h:118 [kernel-doc WARN] : function name from comment differs: v4l2_prio_close <--> v4l2_prio_check
include/media/v4l2-event.h:225 [kernel-doc WARN] : missing initial short description of 'v4l2_src_change_event_subscribe'
[1] https://return42.github.io/linuxdoc/linux.html
The above are real issues at the documentation. On several cases,
caused by cut-and-paste.
Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
71 lines
2.0 KiB
C
71 lines
2.0 KiB
C
/*
|
|
* dvb-math provides some complex fixed-point math
|
|
* operations shared between the dvb related stuff
|
|
*
|
|
* Copyright (C) 2006 Christoph Pfister (christophpfister@gmail.com)
|
|
*
|
|
* This library is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as
|
|
* published by the Free Software Foundation; either version 2.1 of
|
|
* the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*/
|
|
|
|
#ifndef __DVB_MATH_H
|
|
#define __DVB_MATH_H
|
|
|
|
#include <linux/types.h>
|
|
|
|
/**
|
|
* intlog2 - computes log2 of a value; the result is shifted left by 24 bits
|
|
*
|
|
* @value: The value (must be != 0)
|
|
*
|
|
* to use rational values you can use the following method:
|
|
*
|
|
* intlog2(value) = intlog2(value * 2^x) - x * 2^24
|
|
*
|
|
* Some usecase examples:
|
|
*
|
|
* intlog2(8) will give 3 << 24 = 3 * 2^24
|
|
*
|
|
* intlog2(9) will give 3 << 24 + ... = 3.16... * 2^24
|
|
*
|
|
* intlog2(1.5) = intlog2(3) - 2^24 = 0.584... * 2^24
|
|
*
|
|
*
|
|
* return: log2(value) * 2^24
|
|
*/
|
|
extern unsigned int intlog2(u32 value);
|
|
|
|
/**
|
|
* intlog10 - computes log10 of a value; the result is shifted left by 24 bits
|
|
*
|
|
* @value: The value (must be != 0)
|
|
*
|
|
* to use rational values you can use the following method:
|
|
*
|
|
* intlog10(value) = intlog10(value * 10^x) - x * 2^24
|
|
*
|
|
* An usecase example:
|
|
*
|
|
* intlog10(1000) will give 3 << 24 = 3 * 2^24
|
|
*
|
|
* due to the implementation intlog10(1000) might be not exactly 3 * 2^24
|
|
*
|
|
* look at intlog2 for similar examples
|
|
*
|
|
* return: log10(value) * 2^24
|
|
*/
|
|
extern unsigned int intlog10(u32 value);
|
|
|
|
#endif
|