diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-17 13:45:00 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2009-09-19 00:16:12 -0300 |
commit | 3b501de58bf4cd16563d1acec43a11c7cd1517fe (patch) | |
tree | 3cb786d293c6e2dddc593b810eed657e585ec751 /Documentation | |
parent | 6df84ea86e3ae331bd692fb4fbf8b75f43bb4262 (diff) |
Docbook/media: Fix some issues at the docbooks
- Add a few missing entities;
- Some text fixes at remote controllers;
- Add a missing tag at videodev2.h xml version.
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/DocBook/media-entities.tmpl | 181 | ||||
-rw-r--r-- | Documentation/DocBook/v4l/remote_controllers.xml | 6 | ||||
-rw-r--r-- | Documentation/DocBook/v4l/videodev2.h.xml | 1 |
3 files changed, 95 insertions, 93 deletions
diff --git a/Documentation/DocBook/media-entities.tmpl b/Documentation/DocBook/media-entities.tmpl index 944087b5733e..0eb43c1970bb 100644 --- a/Documentation/DocBook/media-entities.tmpl +++ b/Documentation/DocBook/media-entities.tmpl @@ -203,96 +203,6 @@ <!ENTITY sub-libv4l SYSTEM "v4l/libv4l.xml"> <!ENTITY sub-remote_controllers SYSTEM "v4l/remote_controllers.xml"> <!ENTITY sub-fdl-appendix SYSTEM "v4l/fdl-appendix.xml"> -<!ENTITY sub-func-close SYSTEM "v4l/func-close.xml"> -<!ENTITY sub-func-ioctl SYSTEM "v4l/func-ioctl.xml"> -<!ENTITY sub-func-mmap SYSTEM "v4l/func-mmap.xml"> -<!ENTITY sub-func-munmap SYSTEM "v4l/func-munmap.xml"> -<!ENTITY sub-func-open SYSTEM "v4l/func-open.xml"> -<!ENTITY sub-func-poll SYSTEM "v4l/func-poll.xml"> -<!ENTITY sub-func-read SYSTEM "v4l/func-read.xml"> -<!ENTITY sub-func-select SYSTEM "v4l/func-select.xml"> -<!ENTITY sub-func-write SYSTEM "v4l/func-write.xml"> -<!ENTITY sub-io SYSTEM "v4l/io.xml"> -<!ENTITY sub-pixfmt-grey SYSTEM "v4l/pixfmt-grey.xml"> -<!ENTITY sub-pixfmt-nv12 SYSTEM "v4l/pixfmt-nv12.xml"> -<!ENTITY sub-pixfmt-nv16 SYSTEM "v4l/pixfmt-nv16.xml"> -<!ENTITY sub-pixfmt-packed-rgb SYSTEM "v4l/pixfmt-packed-rgb.xml"> -<!ENTITY sub-pixfmt-packed-yuv SYSTEM "v4l/pixfmt-packed-yuv.xml"> -<!ENTITY sub-pixfmt-sbggr16 SYSTEM "v4l/pixfmt-sbggr16.xml"> -<!ENTITY sub-pixfmt-sbggr8 SYSTEM "v4l/pixfmt-sbggr8.xml"> -<!ENTITY sub-pixfmt-sgbrg8 SYSTEM "v4l/pixfmt-sgbrg8.xml"> -<!ENTITY sub-pixfmt-sgrbg8 SYSTEM "v4l/pixfmt-sgrbg8.xml"> -<!ENTITY sub-pixfmt-uyvy SYSTEM "v4l/pixfmt-uyvy.xml"> -<!ENTITY sub-pixfmt-vyuy SYSTEM "v4l/pixfmt-vyuy.xml"> -<!ENTITY sub-pixfmt-y16 SYSTEM "v4l/pixfmt-y16.xml"> -<!ENTITY sub-pixfmt-y41p SYSTEM "v4l/pixfmt-y41p.xml"> -<!ENTITY sub-pixfmt-yuv410 SYSTEM "v4l/pixfmt-yuv410.xml"> -<!ENTITY sub-pixfmt-yuv411p SYSTEM "v4l/pixfmt-yuv411p.xml"> -<!ENTITY sub-pixfmt-yuv420 SYSTEM "v4l/pixfmt-yuv420.xml"> -<!ENTITY sub-pixfmt-yuv422p SYSTEM "v4l/pixfmt-yuv422p.xml"> -<!ENTITY sub-pixfmt-yuyv SYSTEM "v4l/pixfmt-yuyv.xml"> -<!ENTITY sub-pixfmt-yvyu SYSTEM "v4l/pixfmt-yvyu.xml"> -<!ENTITY sub-pixfmt SYSTEM "v4l/pixfmt.xml"> -<!ENTITY sub-vidioc-cropcap SYSTEM "v4l/vidioc-cropcap.xml"> -<!ENTITY sub-vidioc-dbg-g-register SYSTEM "v4l/vidioc-dbg-g-register.xml"> -<!ENTITY sub-vidioc-encoder-cmd SYSTEM "v4l/vidioc-encoder-cmd.xml"> -<!ENTITY sub-vidioc-enum-fmt SYSTEM "v4l/vidioc-enum-fmt.xml"> -<!ENTITY sub-vidioc-enum-frameintervals SYSTEM "v4l/vidioc-enum-frameintervals.xml"> -<!ENTITY sub-vidioc-enum-framesizes SYSTEM "v4l/vidioc-enum-framesizes.xml"> -<!ENTITY sub-vidioc-enumaudio SYSTEM "v4l/vidioc-enumaudio.xml"> -<!ENTITY sub-vidioc-enumaudioout SYSTEM "v4l/vidioc-enumaudioout.xml"> -<!ENTITY sub-vidioc-enuminput SYSTEM "v4l/vidioc-enuminput.xml"> -<!ENTITY sub-vidioc-enumoutput SYSTEM "v4l/vidioc-enumoutput.xml"> -<!ENTITY sub-vidioc-enumstd SYSTEM "v4l/vidioc-enumstd.xml"> -<!ENTITY sub-vidioc-g-audio SYSTEM "v4l/vidioc-g-audio.xml"> -<!ENTITY sub-vidioc-g-audioout SYSTEM "v4l/vidioc-g-audioout.xml"> -<!ENTITY sub-vidioc-dbg-g-chip-ident SYSTEM "v4l/vidioc-dbg-g-chip-ident.xml"> -<!ENTITY sub-vidioc-g-crop SYSTEM "v4l/vidioc-g-crop.xml"> -<!ENTITY sub-vidioc-g-ctrl SYSTEM "v4l/vidioc-g-ctrl.xml"> -<!ENTITY sub-vidioc-g-enc-index SYSTEM "v4l/vidioc-g-enc-index.xml"> -<!ENTITY sub-vidioc-g-ext-ctrls SYSTEM "v4l/vidioc-g-ext-ctrls.xml"> -<!ENTITY sub-vidioc-g-fbuf SYSTEM "v4l/vidioc-g-fbuf.xml"> -<!ENTITY sub-vidioc-g-fmt SYSTEM "v4l/vidioc-g-fmt.xml"> -<!ENTITY sub-vidioc-g-frequency SYSTEM "v4l/vidioc-g-frequency.xml"> -<!ENTITY sub-vidioc-g-input SYSTEM "v4l/vidioc-g-input.xml"> -<!ENTITY sub-vidioc-g-jpegcomp SYSTEM "v4l/vidioc-g-jpegcomp.xml"> -<!ENTITY sub-vidioc-g-modulator SYSTEM "v4l/vidioc-g-modulator.xml"> -<!ENTITY sub-vidioc-g-output SYSTEM "v4l/vidioc-g-output.xml"> -<!ENTITY sub-vidioc-g-parm SYSTEM "v4l/vidioc-g-parm.xml"> -<!ENTITY sub-vidioc-g-priority SYSTEM "v4l/vidioc-g-priority.xml"> -<!ENTITY sub-vidioc-g-sliced-vbi-cap SYSTEM "v4l/vidioc-g-sliced-vbi-cap.xml"> -<!ENTITY sub-vidioc-g-std SYSTEM "v4l/vidioc-g-std.xml"> -<!ENTITY sub-vidioc-g-tuner SYSTEM "v4l/vidioc-g-tuner.xml"> -<!ENTITY sub-vidioc-log-status SYSTEM "v4l/vidioc-log-status.xml"> -<!ENTITY sub-vidioc-overlay SYSTEM "v4l/vidioc-overlay.xml"> -<!ENTITY sub-vidioc-qbuf SYSTEM "v4l/vidioc-qbuf.xml"> -<!ENTITY sub-vidioc-querybuf SYSTEM "v4l/vidioc-querybuf.xml"> -<!ENTITY sub-vidioc-querycap SYSTEM "v4l/vidioc-querycap.xml"> -<!ENTITY sub-vidioc-queryctrl SYSTEM "v4l/vidioc-queryctrl.xml"> -<!ENTITY sub-vidioc-querystd SYSTEM "v4l/vidioc-querystd.xml"> -<!ENTITY sub-vidioc-reqbufs SYSTEM "v4l/vidioc-reqbufs.xml"> -<!ENTITY sub-vidioc-s-hw-freq-seek SYSTEM "v4l/vidioc-s-hw-freq-seek.xml"> -<!ENTITY sub-vidioc-streamon SYSTEM "v4l/vidioc-streamon.xml"> -<!ENTITY sub-capture-c SYSTEM "v4l/capture.c.xml"> -<!ENTITY sub-keytable-c SYSTEM "v4l/keytable.c.xml"> -<!ENTITY sub-v4l2grab-c SYSTEM "v4l/v4l2grab.c.xml"> -<!ENTITY sub-videodev2-h SYSTEM "v4l/videodev2.h.xml"> -<!ENTITY sub-v4l2 SYSTEM "v4l/v4l2.xml"> -<!ENTITY sub-intro SYSTEM "dvb/intro.xml"> -<!ENTITY sub-frontend SYSTEM "dvb/frontend.xml"> -<!ENTITY sub-demux SYSTEM "dvb/demux.xml"> -<!ENTITY sub-video SYSTEM "dvb/video.xml"> -<!ENTITY sub-audio SYSTEM "dvb/audio.xml"> -<!ENTITY sub-ca SYSTEM "dvb/ca.xml"> -<!ENTITY sub-net SYSTEM "dvb/net.xml"> -<!ENTITY sub-kdapi SYSTEM "dvb/kdapi.xml"> -<!ENTITY sub-examples SYSTEM "dvb/examples.xml"> -<!ENTITY sub-dvbapi SYSTEM "dvb/dvbapi.xml"> -<!ENTITY sub-media SYSTEM "media.xml"> -<!ENTITY sub-media-entities SYSTEM "media-entities.xml"> -<!ENTITY sub-media-indices SYSTEM "media-indices.tmpl"> - -<!-- Function Reference --> <!ENTITY sub-close SYSTEM "v4l/func-close.xml"> <!ENTITY sub-ioctl SYSTEM "v4l/func-ioctl.xml"> <!ENTITY sub-mmap SYSTEM "v4l/func-mmap.xml"> @@ -302,6 +212,7 @@ <!ENTITY sub-read SYSTEM "v4l/func-read.xml"> <!ENTITY sub-select SYSTEM "v4l/func-select.xml"> <!ENTITY sub-write SYSTEM "v4l/func-write.xml"> +<!ENTITY sub-io SYSTEM "v4l/io.xml"> <!ENTITY sub-grey SYSTEM "v4l/pixfmt-grey.xml"> <!ENTITY sub-nv12 SYSTEM "v4l/pixfmt-nv12.xml"> <!ENTITY sub-nv16 SYSTEM "v4l/pixfmt-nv16.xml"> @@ -321,6 +232,7 @@ <!ENTITY sub-yuv422p SYSTEM "v4l/pixfmt-yuv422p.xml"> <!ENTITY sub-yuyv SYSTEM "v4l/pixfmt-yuyv.xml"> <!ENTITY sub-yvyu SYSTEM "v4l/pixfmt-yvyu.xml"> +<!ENTITY sub-pixfmt SYSTEM "v4l/pixfmt.xml"> <!ENTITY sub-cropcap SYSTEM "v4l/vidioc-cropcap.xml"> <!ENTITY sub-dbg-g-register SYSTEM "v4l/vidioc-dbg-g-register.xml"> <!ENTITY sub-encoder-cmd SYSTEM "v4l/vidioc-encoder-cmd.xml"> @@ -361,3 +273,92 @@ <!ENTITY sub-reqbufs SYSTEM "v4l/vidioc-reqbufs.xml"> <!ENTITY sub-s-hw-freq-seek SYSTEM "v4l/vidioc-s-hw-freq-seek.xml"> <!ENTITY sub-streamon SYSTEM "v4l/vidioc-streamon.xml"> +<!ENTITY sub-capture-c SYSTEM "v4l/capture.c.xml"> +<!ENTITY sub-keytable-c SYSTEM "v4l/keytable.c.xml"> +<!ENTITY sub-v4l2grab-c SYSTEM "v4l/v4l2grab.c.xml"> +<!ENTITY sub-videodev2-h SYSTEM "v4l/videodev2.h.xml"> +<!ENTITY sub-v4l2 SYSTEM "v4l/v4l2.xml"> +<!ENTITY sub-intro SYSTEM "dvb/intro.xml"> +<!ENTITY sub-frontend SYSTEM "dvb/frontend.xml"> +<!ENTITY sub-isdbt SYSTEM "dvb/isdbt.xml"> +<!ENTITY sub-demux SYSTEM "dvb/demux.xml"> +<!ENTITY sub-video SYSTEM "dvb/video.xml"> +<!ENTITY sub-audio SYSTEM "dvb/audio.xml"> +<!ENTITY sub-ca SYSTEM "dvb/ca.xml"> +<!ENTITY sub-net SYSTEM "dvb/net.xml"> +<!ENTITY sub-kdapi SYSTEM "dvb/kdapi.xml"> +<!ENTITY sub-examples SYSTEM "dvb/examples.xml"> +<!ENTITY sub-dvbapi SYSTEM "dvb/dvbapi.xml"> +<!ENTITY sub-media SYSTEM "media.xml"> +<!ENTITY sub-media-entities SYSTEM "media-entities.tmpl"> +<!ENTITY sub-media-indices SYSTEM "media-indices.tmpl"> + +<!-- Function Reference --> +<!ENTITY close SYSTEM "v4l/func-close.xml"> +<!ENTITY ioctl SYSTEM "v4l/func-ioctl.xml"> +<!ENTITY mmap SYSTEM "v4l/func-mmap.xml"> +<!ENTITY munmap SYSTEM "v4l/func-munmap.xml"> +<!ENTITY open SYSTEM "v4l/func-open.xml"> +<!ENTITY poll SYSTEM "v4l/func-poll.xml"> +<!ENTITY read SYSTEM "v4l/func-read.xml"> +<!ENTITY select SYSTEM "v4l/func-select.xml"> +<!ENTITY write SYSTEM "v4l/func-write.xml"> +<!ENTITY grey SYSTEM "v4l/pixfmt-grey.xml"> +<!ENTITY nv12 SYSTEM "v4l/pixfmt-nv12.xml"> +<!ENTITY nv16 SYSTEM "v4l/pixfmt-nv16.xml"> +<!ENTITY packed-rgb SYSTEM "v4l/pixfmt-packed-rgb.xml"> +<!ENTITY packed-yuv SYSTEM "v4l/pixfmt-packed-yuv.xml"> +<!ENTITY sbggr16 SYSTEM "v4l/pixfmt-sbggr16.xml"> +<!ENTITY sbggr8 SYSTEM "v4l/pixfmt-sbggr8.xml"> +<!ENTITY sgbrg8 SYSTEM "v4l/pixfmt-sgbrg8.xml"> +<!ENTITY sgrbg8 SYSTEM "v4l/pixfmt-sgrbg8.xml"> +<!ENTITY uyvy SYSTEM "v4l/pixfmt-uyvy.xml"> +<!ENTITY vyuy SYSTEM "v4l/pixfmt-vyuy.xml"> +<!ENTITY y16 SYSTEM "v4l/pixfmt-y16.xml"> +<!ENTITY y41p SYSTEM "v4l/pixfmt-y41p.xml"> +<!ENTITY yuv410 SYSTEM "v4l/pixfmt-yuv410.xml"> +<!ENTITY yuv411p SYSTEM "v4l/pixfmt-yuv411p.xml"> +<!ENTITY yuv420 SYSTEM "v4l/pixfmt-yuv420.xml"> +<!ENTITY yuv422p SYSTEM "v4l/pixfmt-yuv422p.xml"> +<!ENTITY yuyv SYSTEM "v4l/pixfmt-yuyv.xml"> +<!ENTITY yvyu SYSTEM "v4l/pixfmt-yvyu.xml"> +<!ENTITY cropcap SYSTEM "v4l/vidioc-cropcap.xml"> +<!ENTITY dbg-g-register SYSTEM "v4l/vidioc-dbg-g-register.xml"> +<!ENTITY encoder-cmd SYSTEM "v4l/vidioc-encoder-cmd.xml"> +<!ENTITY enum-fmt SYSTEM "v4l/vidioc-enum-fmt.xml"> +<!ENTITY enum-frameintervals SYSTEM "v4l/vidioc-enum-frameintervals.xml"> +<!ENTITY enum-framesizes SYSTEM "v4l/vidioc-enum-framesizes.xml"> +<!ENTITY enumaudio SYSTEM "v4l/vidioc-enumaudio.xml"> +<!ENTITY enumaudioout SYSTEM "v4l/vidioc-enumaudioout.xml"> +<!ENTITY enuminput SYSTEM "v4l/vidioc-enuminput.xml"> +<!ENTITY enumoutput SYSTEM "v4l/vidioc-enumoutput.xml"> +<!ENTITY enumstd SYSTEM "v4l/vidioc-enumstd.xml"> +<!ENTITY g-audio SYSTEM "v4l/vidioc-g-audio.xml"> +<!ENTITY g-audioout SYSTEM "v4l/vidioc-g-audioout.xml"> +<!ENTITY dbg-g-chip-ident SYSTEM "v4l/vidioc-dbg-g-chip-ident.xml"> +<!ENTITY g-crop SYSTEM "v4l/vidioc-g-crop.xml"> +<!ENTITY g-ctrl SYSTEM "v4l/vidioc-g-ctrl.xml"> +<!ENTITY g-enc-index SYSTEM "v4l/vidioc-g-enc-index.xml"> +<!ENTITY g-ext-ctrls SYSTEM "v4l/vidioc-g-ext-ctrls.xml"> +<!ENTITY g-fbuf SYSTEM "v4l/vidioc-g-fbuf.xml"> +<!ENTITY g-fmt SYSTEM "v4l/vidioc-g-fmt.xml"> +<!ENTITY g-frequency SYSTEM "v4l/vidioc-g-frequency.xml"> +<!ENTITY g-input SYSTEM "v4l/vidioc-g-input.xml"> +<!ENTITY g-jpegcomp SYSTEM "v4l/vidioc-g-jpegcomp.xml"> +<!ENTITY g-modulator SYSTEM "v4l/vidioc-g-modulator.xml"> +<!ENTITY g-output SYSTEM "v4l/vidioc-g-output.xml"> +<!ENTITY g-parm SYSTEM "v4l/vidioc-g-parm.xml"> +<!ENTITY g-priority SYSTEM "v4l/vidioc-g-priority.xml"> +<!ENTITY g-sliced-vbi-cap SYSTEM "v4l/vidioc-g-sliced-vbi-cap.xml"> +<!ENTITY g-std SYSTEM "v4l/vidioc-g-std.xml"> +<!ENTITY g-tuner SYSTEM "v4l/vidioc-g-tuner.xml"> +<!ENTITY log-status SYSTEM "v4l/vidioc-log-status.xml"> +<!ENTITY overlay SYSTEM "v4l/vidioc-overlay.xml"> +<!ENTITY qbuf SYSTEM "v4l/vidioc-qbuf.xml"> +<!ENTITY querybuf SYSTEM "v4l/vidioc-querybuf.xml"> +<!ENTITY querycap SYSTEM "v4l/vidioc-querycap.xml"> +<!ENTITY queryctrl SYSTEM "v4l/vidioc-queryctrl.xml"> +<!ENTITY querystd SYSTEM "v4l/vidioc-querystd.xml"> +<!ENTITY reqbufs SYSTEM "v4l/vidioc-reqbufs.xml"> +<!ENTITY s-hw-freq-seek SYSTEM "v4l/vidioc-s-hw-freq-seek.xml"> +<!ENTITY streamon SYSTEM "v4l/vidioc-streamon.xml"> diff --git a/Documentation/DocBook/v4l/remote_controllers.xml b/Documentation/DocBook/v4l/remote_controllers.xml index 985325cbc9ad..73f5eab091f4 100644 --- a/Documentation/DocBook/v4l/remote_controllers.xml +++ b/Documentation/DocBook/v4l/remote_controllers.xml @@ -2,12 +2,12 @@ <section id="Remote_controllers_Intro"> <title>Introduction</title> -<para>Currently, most analog and digital devices have a Infrared input for remote controllers. Each -manufacturer has their own type of control. It is not rare for the same manufacturer to ship different +<para>Currently, most analog and digital devices have a Infrared input for remote controllers. Each +manufacturer has their own type of control. It is not rare for the same manufacturer to ship different types of controls, depending on the device.</para> <para>Unfortunately, for several years, there was no effort to create uniform IR keycodes for different devices. This caused the same IR keyname to be mapped completely differently on -different IR devices. This resulted that the same IR keyname to be mapped completely different on +different IR devices. This resulted that the same IR keyname to be mapped completely different on different IR's. Due to that, V4L2 API now specifies a standard for mapping Media keys on IR.</para> <para>This standard should be used by both V4L/DVB drivers and userspace applications</para> <para>The modules register the remote as keyboard within the linux input layer. This means that the IR key strokes will look like normal keyboard key strokes (if CONFIG_INPUT_KEYBOARD is enabled). Using the event devices (CONFIG_INPUT_EVDEV) it is possible for applications to access the remote via /dev/input/event devices.</para> diff --git a/Documentation/DocBook/v4l/videodev2.h.xml b/Documentation/DocBook/v4l/videodev2.h.xml index 6a8e13940699..97002060ac4f 100644 --- a/Documentation/DocBook/v4l/videodev2.h.xml +++ b/Documentation/DocBook/v4l/videodev2.h.xml @@ -362,6 +362,7 @@ struct <link linkend="v4l2-pix-format">v4l2_pix_format</link> { #define <link linkend="V4L2-PIX-FMT-PJPG">V4L2_PIX_FMT_PJPG</link> v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */ #define <link linkend="V4L2-PIX-FMT-OV511">V4L2_PIX_FMT_OV511</link> v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */ #define <link linkend="V4L2-PIX-FMT-OV518">V4L2_PIX_FMT_OV518</link> v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */ +#define <link linkend="V4L2-PIX-FMT-TM6000">V4L2_PIX_FMT_TM6000</link> v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */ /* * F O R M A T E N U M E R A T I O N |