Skip to content

Commit

Permalink
[media] DocBook/device-drivers: Add drivers/media core stuff
Browse files Browse the repository at this point in the history
There are lots of docbook marks at the media subsystem, but
those aren't used.

Add the core headers/code in order to start generating docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Acked-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
Mauro Carvalho Chehab committed Aug 22, 2015
1 parent 88c25dc commit dc2c8bd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 4 deletions.
30 changes: 30 additions & 0 deletions Documentation/DocBook/device-drivers.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,36 @@ X!Isound/sound_firmware.c
-->
</chapter>

<chapter id="mediadev">
<title>Media Devices</title>
!Iinclude/media/media-device.h
!Iinclude/media/media-devnode.h
!Iinclude/media/media-entity.h
!Iinclude/media/v4l2-async.h
!Iinclude/media/v4l2-flash-led-class.h
!Iinclude/media/v4l2-mem2mem.h
!Iinclude/media/v4l2-of.h
!Iinclude/media/v4l2-subdev.h
!Iinclude/media/rc-core.h
<!-- FIXME: Removed for now due to document generation inconsistency
X!Iinclude/media/v4l2-ctrls.h
X!Iinclude/media/v4l2-dv-timings.h
X!Iinclude/media/v4l2-event.h
X!Iinclude/media/v4l2-mediabus.h
X!Iinclude/media/videobuf2-memops.h
X!Iinclude/media/videobuf2-core.h
X!Iinclude/media/lirc.h
X!Edrivers/media/dvb-core/dvb_demux.c
X!Idrivers/media/dvb-core/dvb_frontend.h
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_ca_en50221.h
X!Idrivers/media/dvb-core/dvb_math.h
-->

</chapter>

<chapter id="uart16x50">
<title>16x50 UART Driver</title>
!Edrivers/tty/serial/serial_core.c
Expand Down
10 changes: 6 additions & 4 deletions drivers/media/dvb-core/dvb_math.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,10 @@
* to use rational values you can use the following method:
* intlog2(value) = intlog2(value * 2^x) - x * 2^24
*
* example: intlog2(8) will give 3 << 24 = 3 * 2^24
* example: intlog2(9) will give 3 << 24 + ... = 3.16... * 2^24
* example: intlog2(1.5) = intlog2(3) - 2^24 = 0.584... * 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
*
* @param value The value (must be != 0)
* @return log2(value) * 2^24
Expand All @@ -45,7 +46,8 @@ extern unsigned int intlog2(u32 value);
* to use rational values you can use the following method:
* intlog10(value) = intlog10(value * 10^x) - x * 2^24
*
* example: intlog10(1000) will give 3 << 24 = 3 * 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
Expand Down

0 comments on commit dc2c8bd

Please sign in to comment.