summaryrefslogtreecommitdiffstats
path: root/drivers/media/dvb-core/dvb_math.h
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@linux-foundation.org>2016-07-27 14:58:31 -0700
committerLinus Torvalds <torvalds@linux-foundation.org>2016-07-27 14:58:31 -0700
commitff9a082fda424257976f08fce942609f358015e0 (patch)
tree478e6b449b19baaf842369a13923499ce83ef895 /drivers/media/dvb-core/dvb_math.h
parent6a492b0f23d28e1f946cdf08e54617484400dafb (diff)
parent85538b1ad145c67198cb55d02de14ba269cc323d (diff)
downloadtalos-op-linux-ff9a082fda424257976f08fce942609f358015e0.tar.gz
talos-op-linux-ff9a082fda424257976f08fce942609f358015e0.zip
Merge tag 'media/v4.8-4' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media
Pull media documentation updates from Mauro Carvalho Chehab: "This patch series does the conversion of all media documentation stuff to Restrutured Text markup format and add them to the Documentation/index.rst file. The media documentation was grouped into 4 books: - media uAPI - media kAPI - V4L driver-specific documentation - DVB driver-specific documentation It also contains several documentation improvements and one fixup patch for a core issue with cropcap. PS. After this patch series, the media DocBook is deprecated and should be removed. I'll add such patch on a future pull request" * tag 'media/v4.8-4' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab/linux-media: (322 commits) [media] cx23885-cardlist.rst: add a new card [media] doc-rst: add some needed escape codes [media] doc-rst: kapi: use :c:func: instead of :cpp:func doc-rst: kernel-doc: fix a change introduced by mistake [media] v4l2-ioctl.h add debug info for struct v4l2_ioctl_ops [media] dvb_ringbuffer.h: some documentation improvements [media] v4l2-ctrls.h: fully document the header file [media] doc-rst: Fix some typedef ugly warnings [media] doc-rst: reorganize the kAPI v4l2 chapters [media] rename v4l2-framework.rst to v4l2-intro.rst [media] move V4L2 clocks to a separate .rst file [media] v4l2-fh.rst: add cross references and markups [media] v4l2-fh.rst: add fh contents from v4l2-framework.rst [media] v4l2-fh.h: add documentation for it [media] v4l2-event.rst: add cross-references and markups [media] v4l2-event.h: document all functions [media] v4l2-event.rst: add text from v4l2-framework.rst [media] v4l2-framework.rst: remove videobuf quick chapter [media] v4l2-dev: add cross-references and improve markup [media] doc-rst: move v4l2-dev doc to a separate file ...
Diffstat (limited to 'drivers/media/dvb-core/dvb_math.h')
-rw-r--r--drivers/media/dvb-core/dvb_math.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/drivers/media/dvb-core/dvb_math.h b/drivers/media/dvb-core/dvb_math.h
index 34dc1df03cab..2f0326674ca6 100644
--- a/drivers/media/dvb-core/dvb_math.h
+++ b/drivers/media/dvb-core/dvb_math.h
@@ -30,11 +30,15 @@
* @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
*
*
@@ -48,10 +52,13 @@ extern unsigned int intlog2(u32 value);
* @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
OpenPOWER on IntegriCloud