tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
[media] DocBook: add dvb_math.h to documentation
There are already some comments at dvb_math.h that are ready
for DocBook, although not properly formatted.
Convert them, fix some issues 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>
+10
-7
+1
-1
Documentation/DocBook/device-drivers.tmpl
+1
-1
Documentation/DocBook/device-drivers.tmpl
···
229
229
!Iinclude/media/rc-core.h
230
230
!Idrivers/media/dvb-core/dvb_ca_en50221.h
231
231
!Idrivers/media/dvb-core/dvb_frontend.h
232
+
!Idrivers/media/dvb-core/dvb_math.h
232
233
<!-- FIXME: Removed for now due to document generation inconsistency
233
234
X!Iinclude/media/v4l2-ctrls.h
234
235
X!Iinclude/media/v4l2-dv-timings.h
···
242
241
X!Idrivers/media/dvb-core/dvbdev.h
243
242
X!Edrivers/media/dvb-core/dvb_net.c
244
243
X!Idrivers/media/dvb-core/dvb_ringbuffer.h
245
-
X!Idrivers/media/dvb-core/dvb_math.h
246
244
-->
247
245
248
246
</chapter>
+9
-6
drivers/media/dvb-core/dvb_math.h
+9
-6
drivers/media/dvb-core/dvb_math.h
···
25
25
#include <linux/types.h>
26
26
27
27
/**
28
-
* computes log2 of a value; the result is shifted left by 24 bits
28
+
* cintlog2 - computes log2 of a value; the result is shifted left by 24 bits
29
+
*
30
+
* @value: The value (must be != 0)
29
31
*
30
32
* to use rational values you can use the following method:
31
33
* intlog2(value) = intlog2(value * 2^x) - x * 2^24
···
37
35
* intlog2(9) will give 3 << 24 + ... = 3.16... * 2^24
38
36
* intlog2(1.5) = intlog2(3) - 2^24 = 0.584... * 2^24
39
37
*
40
-
* @param value The value (must be != 0)
41
-
* @return log2(value) * 2^24
38
+
*
39
+
* return: log2(value) * 2^24
42
40
*/
43
41
extern unsigned int intlog2(u32 value);
44
42
45
43
/**
46
-
* computes log10 of a value; the result is shifted left by 24 bits
44
+
* intlog10 - computes log10 of a value; the result is shifted left by 24 bits
45
+
*
46
+
* @value: The value (must be != 0)
47
47
*
48
48
* to use rational values you can use the following method:
49
49
* intlog10(value) = intlog10(value * 10^x) - x * 2^24
···
56
52
*
57
53
* look at intlog2 for similar examples
58
54
*
59
-
* @param value The value (must be != 0)
60
-
* @return log10(value) * 2^24
55
+
* return: log10(value) * 2^24
61
56
*/
62
57
extern unsigned int intlog10(u32 value);
63
58