Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e08bb6f7 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[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: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 4f1c1868

Documentation/DocBook/device-drivers.tmpl

+1 −1
Original line number Diff line number Diff line
@@ -229,6 +229,7 @@ X!Isound/sound_firmware.c 
!Iinclude/media/rc-core.h

!Idrivers/media/dvb-core/dvb_ca_en50221.h

!Idrivers/media/dvb-core/dvb_frontend.h

!Idrivers/media/dvb-core/dvb_math.h

<!-- FIXME: Removed for now due to document generation inconsistency

X!Iinclude/media/v4l2-ctrls.h

X!Iinclude/media/v4l2-dv-timings.h
@@ -241,7 +242,6 @@ X!Edrivers/media/dvb-core/dvb_demux.c 
X!Idrivers/media/dvb-core/dvbdev.h

X!Edrivers/media/dvb-core/dvb_net.c

X!Idrivers/media/dvb-core/dvb_ringbuffer.h

X!Idrivers/media/dvb-core/dvb_math.h

-->



  </chapter>

drivers/media/dvb-core/dvb_math.h

+9 −6
Original line number Diff line number Diff line
@@ -25,7 +25,9 @@ 
#include <linux/types.h>



/**

 * computes log2 of a value; the result is shifted left by 24 bits

 * cintlog2 - 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
@@ -35,13 +37,15 @@ 
 *	intlog2(9) will give 3 << 24 + ... = 3.16... * 2^24

 *	intlog2(1.5) = intlog2(3) - 2^24 = 0.584... * 2^24

 *

 * @param value The value (must be != 0)

 * @return log2(value) * 2^24

 *

 * return: log2(value) * 2^24

 */

extern unsigned int intlog2(u32 value);



/**

 * computes log10 of a value; the result is shifted left by 24 bits

 * 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
@@ -52,8 +56,7 @@ extern unsigned int intlog2(u32 value); 
 *

 * look at intlog2 for similar examples

 *

 * @param value The value (must be != 0)

 * @return log10(value) * 2^24

 * return: log10(value) * 2^24

 */

extern unsigned int intlog10(u32 value);