* [PATCH 00/54] Second series of ReST convert patches for media
@ 2016-07-08 13:02 Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 01/54] doc-rst: linux_tv: split DVB function call documentation Mauro Carvalho Chehab
` (54 more replies)
0 siblings, 55 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
That's the second series of patches related to DocBook to ReST
conversion. With this patch series, we're ready to merge it
upstream.
There are still one thing to do: there are some new updates at
the DocBook pages on two topic branches (cec and vsp1). Those
changes should also be converted, in order to be able to remove
the DocBook pages.
Visually, I'm more happy with the new pages, as the produced
layout is more fancy, IMHO, using a modern visual.
Also, editing ReST pages is a way simpler than editing the
DocBooks. Also, reviewing documentation patches should be
simpler, with is a good thing.
On the bad side, Sphinx doesn't support auto-numberating
examples, figures or tables. We'll need some extension for
that. For now, the only impact is on the examples, that were
manually numerated. So, patches adding new examples will need
to check and manually renumerate other examples.
I hope we'll have soon some Sphinx extension to support
auto-numbering.
I'll soon change linux.org documentation page to show the
Sphinx-generated documenation. I intend to keep the old
one for a while, for people to be able to compare both.
I'll post an email once I do this at both linux-media and
linux-doc mailing lists.
I did a review on all pages, but, as I'm not a Vulcan,
I'm pretty sure I missed some things. So, feel free to
review the final document and send me patches with any
needed fixes or improvements.
Finally, you'll see some warnings produced by generating
the documentation.
There are actually two types of warnings there:
1) At least here where I sit, I'm getting those warnings:
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst:18: WARNING: Error when parsing function declaration:
If no return type {
Invalid definition: Expected identifier in nested name, got keyword: int [error at 3]
int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
---^
} else if return type {
Invalid definition: Expected identifier in nested name, got keyword: enum [error at 36]
int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
------------------------------------^
}
It seems that the cpp:function:: parser on Sphinx doesn't
know how to handle enums. I'll try to woraround this issue later.
2) Undefined label warnings.
This is actually some gaps that I detected when comparing
what's documented with what's there at videodev2.h:
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-ycbcr-encoding-fixme (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-ycbcr-encoding-fixme (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-ycbcr-encoding-fixme (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: buffer-flags-fixme (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-dv-fixme (if the link has no caption the label must precede a section header)
Documentation/output/videodev2.h.rst:6: WARNING: undefined label: v4l2-dv-fixme (if the link has no caption the label must precede a section header)
Those are things that we need to fix by either documenting
some things or by removing/deprecating some old/unused stuff.
Markus Heiser (6):
doc-rst: boilerplate HTML theme customization
doc-rst: customize RTD theme, table & full width
doc-rst: customize RTD theme, captions & inline literal
doc-rst: auto-generate: fixed include "output/*.h.rst" content
doc-rst: add kernel-include directive
doc-rst: linux_tv/Makefile: Honor quiet make O=dir
Mauro Carvalho Chehab (48):
doc-rst: linux_tv: split DVB function call documentation
doc-rst: linux_tv: reformat all syscall pages
doc-rst: linux_tv: dvb: use lowercase for filenames
doc-rst: linux_tv: dvb: put return value at the end
doc-rst: remove Documentation/linux_tv/conf.py file
doc-rst: linux_tv: don't use uppercases for syscall sections
doc-rst: linux_tv: use :cpp:function:: on all syscalls
doc-rst: dmabuf: Fix the cross-reference
doc-rst: dev-overlay: fix the last warning
doc-rst: dvbapi: Fix conversion issues
doc-rst: fix intro_files/dvbstb.png image
doc-rst: dvb/intro: Better show the needed include blocks
doc-rst: intro: remove obsolete headers
doc-rst: media-controller: fix conversion issues
doc-rst: media-controller: missing credits
doc-rst: media-controller.rst: add missing copy symbol
doc-rst: media-controller-model: fix a typo
doc-rst: mediactl: fix some wrong cross references
doc-rst: media-ioc-g-topology: Fix tables
doc-rst: media-ioc-enum-entities: better format the table
doc-rst: gen-errors: Improve table layout
doc-rst: remote_controllers: fix conversion issues
doc-rst: Rename the title of the Digital TV section
doc-rst: v4l2: Rename the V4L2 API title
doc-rst: linux_tv/index: Rename the book name
doc-rst: add parse-headers.pl script
doc-rst: auto-build the frontend.h.rst
doc-rst: parse-headers: improve delimiters to detect symbols
doc-dst: parse-headers: highlight deprecated comments
doc-rst: fix parsing comments and '{' on a separate line
doc-rst: parse-headers: be more formal about the valid symbols
doc-rst: parse-headers: better handle typedefs
doc-rst: parse-headers: fix multiline typedef handler
doc-rst: auto-generate dmx.h.rst
doc-rst: auto-generate audio.h.rst
doc-rst: auto-generate ca.h.rst
doc-rst: auto-generate net.h.rst
doc-rst: auto-generate video.h.rst
doc-rst: parse-headers: better handle comments at the source code
doc-rst: parse-headers: add an option to ignore enum symbols
doc-rst: parse-headers: don't do substituition references
doc-rst: autogenerate videodev2.h.rst file
doc-rst: fix some badly converted references
doc-rst: linux_tv: Don't ignore pix formats
doc-rst: videodev2.h: don't ignore V4L2_STD macros
doc-rst: document enum symbols
doc-rst: videodev2.h: add cross-references for defines
doc-rst: linux_tv/Makefile: Honor quiet mode
Documentation/Makefile.sphinx | 3 +-
Documentation/conf.py | 11 +-
Documentation/linux_tv/Makefile | 50 +
Documentation/linux_tv/audio.h.rst | 142 --
Documentation/linux_tv/audio.h.rst.exceptions | 20 +
Documentation/linux_tv/ca.h.rst | 97 -
Documentation/linux_tv/ca.h.rst.exceptions | 24 +
Documentation/linux_tv/conf.py | 221 --
Documentation/linux_tv/dmx.h.rst | 162 --
Documentation/linux_tv/dmx.h.rst.exceptions | 63 +
Documentation/linux_tv/frontend.h.rst | 609 ------
Documentation/linux_tv/frontend.h.rst.exceptions | 47 +
Documentation/linux_tv/index.rst | 2 +-
.../media/dvb/audio-bilingual-channel-select.rst | 64 +
.../linux_tv/media/dvb/audio-channel-select.rst | 63 +
.../linux_tv/media/dvb/audio-clear-buffer.rst | 54 +
.../linux_tv/media/dvb/audio-continue.rst | 54 +
Documentation/linux_tv/media/dvb/audio-fclose.rst | 54 +
Documentation/linux_tv/media/dvb/audio-fopen.rst | 104 +
Documentation/linux_tv/media/dvb/audio-fwrite.rst | 82 +
.../linux_tv/media/dvb/audio-get-capabilities.rst | 60 +
Documentation/linux_tv/media/dvb/audio-get-pts.rst | 69 +
.../linux_tv/media/dvb/audio-get-status.rst | 60 +
Documentation/linux_tv/media/dvb/audio-pause.rst | 55 +
Documentation/linux_tv/media/dvb/audio-play.rst | 54 +
.../linux_tv/media/dvb/audio-select-source.rst | 62 +
.../linux_tv/media/dvb/audio-set-attributes.rst | 71 +
.../linux_tv/media/dvb/audio-set-av-sync.rst | 70 +
.../linux_tv/media/dvb/audio-set-bypass-mode.rst | 74 +
.../linux_tv/media/dvb/audio-set-ext-id.rst | 71 +
Documentation/linux_tv/media/dvb/audio-set-id.rst | 65 +
.../linux_tv/media/dvb/audio-set-karaoke.rst | 70 +
.../linux_tv/media/dvb/audio-set-mixer.rst | 59 +
.../linux_tv/media/dvb/audio-set-mute.rst | 74 +
.../linux_tv/media/dvb/audio-set-streamtype.rst | 74 +
Documentation/linux_tv/media/dvb/audio-stop.rst | 54 +
.../linux_tv/media/dvb/audio_function_calls.rst | 1399 +-----------
Documentation/linux_tv/media/dvb/audio_h.rst | 6 +-
Documentation/linux_tv/media/dvb/ca-fclose.rst | 54 +
Documentation/linux_tv/media/dvb/ca-fopen.rst | 109 +
Documentation/linux_tv/media/dvb/ca-get-cap.rst | 59 +
.../linux_tv/media/dvb/ca-get-descr-info.rst | 59 +
Documentation/linux_tv/media/dvb/ca-get-msg.rst | 59 +
.../linux_tv/media/dvb/ca-get-slot-info.rst | 59 +
Documentation/linux_tv/media/dvb/ca-reset.rst | 53 +
Documentation/linux_tv/media/dvb/ca-send-msg.rst | 59 +
Documentation/linux_tv/media/dvb/ca-set-descr.rst | 59 +
Documentation/linux_tv/media/dvb/ca-set-pid.rst | 59 +
.../linux_tv/media/dvb/ca_function_calls.rst | 577 +----
Documentation/linux_tv/media/dvb/ca_h.rst | 6 +-
Documentation/linux_tv/media/dvb/dmx-add-pid.rst | 61 +
Documentation/linux_tv/media/dvb/dmx-fclose.rst | 55 +
Documentation/linux_tv/media/dvb/dmx-fopen.rst | 108 +
Documentation/linux_tv/media/dvb/dmx-fread.rst | 108 +
Documentation/linux_tv/media/dvb/dmx-fwrite.rst | 89 +
Documentation/linux_tv/media/dvb/dmx-get-caps.rst | 59 +
Documentation/linux_tv/media/dvb/dmx-get-event.rst | 76 +
.../linux_tv/media/dvb/dmx-get-pes-pids.rst | 59 +
Documentation/linux_tv/media/dvb/dmx-get-stc.rst | 77 +
.../linux_tv/media/dvb/dmx-remove-pid.rst | 62 +
.../linux_tv/media/dvb/dmx-set-buffer-size.rst | 62 +
.../linux_tv/media/dvb/dmx-set-filter.rst | 68 +
.../linux_tv/media/dvb/dmx-set-pes-filter.rst | 78 +
.../linux_tv/media/dvb/dmx-set-source.rst | 59 +
Documentation/linux_tv/media/dvb/dmx-start.rst | 77 +
Documentation/linux_tv/media/dvb/dmx-stop.rst | 55 +
Documentation/linux_tv/media/dvb/dmx_fcalls.rst | 1075 +--------
Documentation/linux_tv/media/dvb/dmx_h.rst | 6 +-
Documentation/linux_tv/media/dvb/dmx_types.rst | 8 +-
Documentation/linux_tv/media/dvb/dvbapi.rst | 34 +-
.../linux_tv/media/dvb/fe-bandwidth-t.rst | 14 +-
.../media/dvb/fe-diseqc-recv-slave-reply.rst | 24 +-
.../media/dvb/fe-diseqc-reset-overload.rst | 11 +-
.../linux_tv/media/dvb/fe-diseqc-send-burst.rst | 28 +-
.../media/dvb/fe-diseqc-send-master-cmd.rst | 24 +-
..._CMD.rst => fe-dishnetwork-send-legacy-cmd.rst} | 36 +-
.../media/dvb/fe-enable-high-lnb-voltage.rst | 11 +-
.../dvb/{FE_GET_EVENT.rst => fe-get-event.rst} | 32 +-
.../{FE_GET_FRONTEND.rst => fe-get-frontend.rst} | 26 +-
Documentation/linux_tv/media/dvb/fe-get-info.rst | 87 +-
.../linux_tv/media/dvb/fe-get-property.rst | 12 +-
.../media/dvb/{FE_READ_BER.rst => fe-read-ber.rst} | 28 +-
...AL_STRENGTH.rst => fe-read-signal-strength.rst} | 28 +-
.../media/dvb/{FE_READ_SNR.rst => fe-read-snr.rst} | 28 +-
.../linux_tv/media/dvb/fe-read-status.rst | 35 +-
...D_BLOCKS.rst => fe-read-uncorrected-blocks.rst} | 32 +-
.../media/dvb/fe-set-frontend-tune-mode.rst | 10 +-
.../{FE_SET_FRONTEND.rst => fe-set-frontend.rst} | 42 +-
Documentation/linux_tv/media/dvb/fe-set-tone.rst | 28 +-
.../linux_tv/media/dvb/fe-set-voltage.rst | 12 +-
Documentation/linux_tv/media/dvb/fe-type-t.rst | 8 +-
.../linux_tv/media/dvb/fe_property_parameters.rst | 206 +-
.../linux_tv/media/dvb/frontend_f_close.rst | 6 +-
.../linux_tv/media/dvb/frontend_f_open.rst | 6 +-
Documentation/linux_tv/media/dvb/frontend_h.rst | 6 +-
.../linux_tv/media/dvb/frontend_legacy_api.rst | 16 +-
Documentation/linux_tv/media/dvb/intro.rst | 23 -
.../linux_tv/media/dvb/intro_files/dvbstb.png | Bin 22703 -> 22655 bytes
Documentation/linux_tv/media/dvb/net-add-if.rst | 91 +
Documentation/linux_tv/media/dvb/net-get-if.rst | 50 +
Documentation/linux_tv/media/dvb/net-remove-if.rst | 46 +
Documentation/linux_tv/media/dvb/net.rst | 180 +-
Documentation/linux_tv/media/dvb/net_h.rst | 6 +-
.../linux_tv/media/dvb/video-clear-buffer.rst | 54 +
Documentation/linux_tv/media/dvb/video-command.rst | 66 +
.../linux_tv/media/dvb/video-continue.rst | 57 +
.../linux_tv/media/dvb/video-fast-forward.rst | 74 +
Documentation/linux_tv/media/dvb/video-fclose.rst | 54 +
Documentation/linux_tv/media/dvb/video-fopen.rst | 112 +
Documentation/linux_tv/media/dvb/video-freeze.rst | 61 +
Documentation/linux_tv/media/dvb/video-fwrite.rst | 82 +
.../linux_tv/media/dvb/video-get-capabilities.rst | 61 +
.../linux_tv/media/dvb/video-get-event.rst | 88 +
.../linux_tv/media/dvb/video-get-frame-count.rst | 65 +
.../linux_tv/media/dvb/video-get-frame-rate.rst | 59 +
.../linux_tv/media/dvb/video-get-navi.rst | 74 +
Documentation/linux_tv/media/dvb/video-get-pts.rst | 69 +
.../linux_tv/media/dvb/video-get-size.rst | 59 +
.../linux_tv/media/dvb/video-get-status.rst | 60 +
Documentation/linux_tv/media/dvb/video-play.rst | 57 +
.../linux_tv/media/dvb/video-select-source.rst | 65 +
.../linux_tv/media/dvb/video-set-attributes.rst | 75 +
.../linux_tv/media/dvb/video-set-blank.rst | 64 +
.../media/dvb/video-set-display-format.rst | 60 +
.../linux_tv/media/dvb/video-set-format.rst | 74 +
.../linux_tv/media/dvb/video-set-highlight.rst | 60 +
Documentation/linux_tv/media/dvb/video-set-id.rst | 73 +
.../linux_tv/media/dvb/video-set-spu-palette.rst | 72 +
Documentation/linux_tv/media/dvb/video-set-spu.rst | 74 +
.../linux_tv/media/dvb/video-set-streamtype.rst | 61 +
.../linux_tv/media/dvb/video-set-system.rst | 75 +
.../linux_tv/media/dvb/video-slowmotion.rst | 74 +
.../linux_tv/media/dvb/video-stillpicture.rst | 61 +
Documentation/linux_tv/media/dvb/video-stop.rst | 74 +
.../linux_tv/media/dvb/video-try-command.rst | 66 +
.../linux_tv/media/dvb/video_function_calls.rst | 2008 +----------------
Documentation/linux_tv/media/dvb/video_h.rst | 6 +-
Documentation/linux_tv/media/gen-errors.rst | 1 +
.../media/mediactl/media-controller-model.rst | 2 +-
.../linux_tv/media/mediactl/media-controller.rst | 24 +-
.../linux_tv/media/mediactl/media-func-close.rst | 8 +-
.../linux_tv/media/mediactl/media-func-ioctl.rst | 10 +-
.../linux_tv/media/mediactl/media-func-open.rst | 8 +-
.../media/mediactl/media-ioc-device-info.rst | 6 +-
.../media/mediactl/media-ioc-enum-entities.rst | 8 +-
.../media/mediactl/media-ioc-enum-links.rst | 7 +-
.../media/mediactl/media-ioc-g-topology.rst | 70 +-
.../media/mediactl/media-ioc-setup-link.rst | 6 +-
.../linux_tv/media/rc/remote_controllers.rst | 16 +-
Documentation/linux_tv/media/v4l/audio.rst | 8 +-
Documentation/linux_tv/media/v4l/control.rst | 6 +-
Documentation/linux_tv/media/v4l/dev-overlay.rst | 2 +-
Documentation/linux_tv/media/v4l/dmabuf.rst | 2 +-
.../linux_tv/media/v4l/extended-controls.rst | 114 +-
Documentation/linux_tv/media/v4l/func-close.rst | 6 +-
Documentation/linux_tv/media/v4l/func-ioctl.rst | 6 +-
Documentation/linux_tv/media/v4l/func-mmap.rst | 6 +-
Documentation/linux_tv/media/v4l/func-munmap.rst | 6 +-
Documentation/linux_tv/media/v4l/func-open.rst | 6 +-
Documentation/linux_tv/media/v4l/func-poll.rst | 11 +-
Documentation/linux_tv/media/v4l/func-read.rst | 6 +-
Documentation/linux_tv/media/v4l/func-select.rst | 11 +-
Documentation/linux_tv/media/v4l/func-write.rst | 6 +-
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 4 +-
Documentation/linux_tv/media/v4l/pixfmt-013.rst | 26 +-
.../linux_tv/media/v4l/pixfmt-indexed.rst | 2 +-
Documentation/linux_tv/media/v4l/pixfmt-nv12.rst | 1 +
Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst | 2 +
Documentation/linux_tv/media/v4l/pixfmt-nv16.rst | 1 +
Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst | 1 +
Documentation/linux_tv/media/v4l/pixfmt-nv24.rst | 1 +
.../linux_tv/media/v4l/pixfmt-packed-rgb.rst | 42 +-
.../linux_tv/media/v4l/pixfmt-packed-yuv.rst | 8 +-
.../linux_tv/media/v4l/pixfmt-reserved.rst | 66 +-
.../linux_tv/media/v4l/pixfmt-sdr-cs08.rst | 2 +-
.../linux_tv/media/v4l/pixfmt-sdr-cu08.rst | 2 +-
.../linux_tv/media/v4l/pixfmt-srggb10.rst | 3 +
.../linux_tv/media/v4l/pixfmt-srggb10alaw8.rst | 3 +
.../linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst | 4 +
.../linux_tv/media/v4l/pixfmt-srggb10p.rst | 3 +
.../linux_tv/media/v4l/pixfmt-srggb12.rst | 4 +
Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst | 1 +
.../linux_tv/media/v4l/pixfmt-yuv420m.rst | 1 +
.../linux_tv/media/v4l/pixfmt-yuv422m.rst | 1 +
.../linux_tv/media/v4l/pixfmt-yuv444m.rst | 1 +
.../linux_tv/media/v4l/subdev-formats.rst | 174 +-
Documentation/linux_tv/media/v4l/v4l2.rst | 8 +-
Documentation/linux_tv/media/v4l/videodev.rst | 6 +-
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 7 +-
.../linux_tv/media/v4l/vidioc-cropcap.rst | 7 +-
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 7 +-
.../linux_tv/media/v4l/vidioc-dbg-g-register.rst | 8 +-
.../linux_tv/media/v4l/vidioc-decoder-cmd.rst | 8 +-
.../linux_tv/media/v4l/vidioc-dqevent.rst | 7 +-
.../linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 16 +-
.../linux_tv/media/v4l/vidioc-encoder-cmd.rst | 8 +-
.../linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 8 +-
.../linux_tv/media/v4l/vidioc-enum-fmt.rst | 7 +-
.../media/v4l/vidioc-enum-frameintervals.rst | 7 +-
.../linux_tv/media/v4l/vidioc-enum-framesizes.rst | 7 +-
.../linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 7 +-
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 6 +-
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 10 +-
.../linux_tv/media/v4l/vidioc-enuminput.rst | 7 +-
.../linux_tv/media/v4l/vidioc-enumoutput.rst | 7 +-
.../linux_tv/media/v4l/vidioc-enumstd.rst | 7 +-
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 7 +-
.../linux_tv/media/v4l/vidioc-g-audio.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-audioout.rst | 10 +-
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 8 +-
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 35 +-
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 10 +-
.../linux_tv/media/v4l/vidioc-g-enc-index.rst | 7 +-
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 9 +-
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 8 +-
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 9 +-
.../linux_tv/media/v4l/vidioc-g-frequency.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-input.rst | 7 +-
.../linux_tv/media/v4l/vidioc-g-jpegcomp.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-output.rst | 7 +-
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-priority.rst | 12 +-
.../linux_tv/media/v4l/vidioc-g-selection.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 7 +-
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 7 +-
.../linux_tv/media/v4l/vidioc-g-tuner.rst | 8 +-
.../linux_tv/media/v4l/vidioc-log-status.rst | 11 +-
.../linux_tv/media/v4l/vidioc-overlay.rst | 6 +-
.../linux_tv/media/v4l/vidioc-prepare-buf.rst | 6 +-
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 7 +-
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 7 +-
.../linux_tv/media/v4l/vidioc-querybuf.rst | 6 +-
.../linux_tv/media/v4l/vidioc-querycap.rst | 7 +-
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 9 +-
.../linux_tv/media/v4l/vidioc-querystd.rst | 6 +-
.../linux_tv/media/v4l/vidioc-reqbufs.rst | 7 +-
.../linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 7 +-
.../linux_tv/media/v4l/vidioc-streamon.rst | 7 +-
.../v4l/vidioc-subdev-enum-frame-interval.rst | 7 +-
.../media/v4l/vidioc-subdev-enum-frame-size.rst | 7 +-
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 7 +-
.../linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 8 +-
.../linux_tv/media/v4l/vidioc-subdev-g-fmt.rst | 9 +-
.../media/v4l/vidioc-subdev-g-frame-interval.rst | 8 +-
.../media/v4l/vidioc-subdev-g-selection.rst | 8 +-
.../linux_tv/media/v4l/vidioc-subscribe-event.rst | 8 +-
Documentation/linux_tv/net.h.rst | 59 -
Documentation/linux_tv/net.h.rst.exceptions | 11 +
Documentation/linux_tv/video.h.rst | 280 ---
Documentation/linux_tv/video.h.rst.exceptions | 40 +
Documentation/linux_tv/videodev2.h.rst | 2300 --------------------
Documentation/linux_tv/videodev2.h.rst.exceptions | 559 +++++
Documentation/sphinx-static/theme_overrides.css | 53 +
Documentation/sphinx/kernel_include.py | 183 ++
Documentation/sphinx/parse-headers.pl | 319 +++
257 files changed, 8271 insertions(+), 10005 deletions(-)
create mode 100644 Documentation/linux_tv/Makefile
delete mode 100644 Documentation/linux_tv/audio.h.rst
create mode 100644 Documentation/linux_tv/audio.h.rst.exceptions
delete mode 100644 Documentation/linux_tv/ca.h.rst
create mode 100644 Documentation/linux_tv/ca.h.rst.exceptions
delete mode 100644 Documentation/linux_tv/conf.py
delete mode 100644 Documentation/linux_tv/dmx.h.rst
create mode 100644 Documentation/linux_tv/dmx.h.rst.exceptions
delete mode 100644 Documentation/linux_tv/frontend.h.rst
create mode 100644 Documentation/linux_tv/frontend.h.rst.exceptions
create mode 100644 Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-channel-select.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-continue.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-fwrite.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-get-pts.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-get-status.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-pause.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-play.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-select-source.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-attributes.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-id.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-mixer.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-mute.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-stop.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-cap.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-msg.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-reset.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-send-msg.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-set-descr.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-set-pid.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-add-pid.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fread.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fwrite.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-caps.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-event.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-stc.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-filter.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-source.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-start.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-stop.rst
rename Documentation/linux_tv/media/dvb/{FE_DISHNETWORK_SEND_LEGACY_CMD.rst => fe-dishnetwork-send-legacy-cmd.rst} (82%)
rename Documentation/linux_tv/media/dvb/{FE_GET_EVENT.rst => fe-get-event.rst} (89%)
rename Documentation/linux_tv/media/dvb/{FE_GET_FRONTEND.rst => fe-get-frontend.rst} (85%)
rename Documentation/linux_tv/media/dvb/{FE_READ_BER.rst => fe-read-ber.rst} (84%)
rename Documentation/linux_tv/media/dvb/{FE_READ_SIGNAL_STRENGTH.rst => fe-read-signal-strength.rst} (83%)
rename Documentation/linux_tv/media/dvb/{FE_READ_SNR.rst => fe-read-snr.rst} (85%)
rename Documentation/linux_tv/media/dvb/{FE_READ_UNCORRECTED_BLOCKS.rst => fe-read-uncorrected-blocks.rst} (85%)
rename Documentation/linux_tv/media/dvb/{FE_SET_FRONTEND.rst => fe-set-frontend.rst} (89%)
create mode 100644 Documentation/linux_tv/media/dvb/net-add-if.rst
create mode 100644 Documentation/linux_tv/media/dvb/net-get-if.rst
create mode 100644 Documentation/linux_tv/media/dvb/net-remove-if.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-clear-buffer.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-command.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-continue.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fast-forward.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-freeze.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fwrite.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-capabilities.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-event.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-frame-count.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-navi.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-pts.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-size.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-status.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-play.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-select-source.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-attributes.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-blank.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-display-format.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-format.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-highlight.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-id.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-spu.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-streamtype.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-system.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-slowmotion.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-stillpicture.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-stop.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-try-command.rst
delete mode 100644 Documentation/linux_tv/net.h.rst
create mode 100644 Documentation/linux_tv/net.h.rst.exceptions
delete mode 100644 Documentation/linux_tv/video.h.rst
create mode 100644 Documentation/linux_tv/video.h.rst.exceptions
delete mode 100644 Documentation/linux_tv/videodev2.h.rst
create mode 100644 Documentation/linux_tv/videodev2.h.rst.exceptions
create mode 100644 Documentation/sphinx-static/theme_overrides.css
create mode 100755 Documentation/sphinx/kernel_include.py
create mode 100755 Documentation/sphinx/parse-headers.pl
--
2.7.4
^ permalink raw reply [flat|nested] 56+ messages in thread
* [PATCH 01/54] doc-rst: linux_tv: split DVB function call documentation
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
@ 2016-07-08 13:02 ` Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 02/54] doc-rst: linux_tv: reformat all syscall pages Mauro Carvalho Chehab
` (53 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 227015 bytes --]
Just like V4L, split the DVB function calls into one file per
system call. This is a requirement for the man pages creator
on Sphinx to work, and makes the document easier to maintain.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../media/dvb/audio-bilingual-channel-select.rst | 59 +
.../linux_tv/media/dvb/audio-channel-select.rst | 58 +
.../linux_tv/media/dvb/audio-clear-buffer.rst | 49 +
.../linux_tv/media/dvb/audio-continue.rst | 49 +
Documentation/linux_tv/media/dvb/audio-fclose.rst | 52 +
Documentation/linux_tv/media/dvb/audio-fopen.rst | 102 +
Documentation/linux_tv/media/dvb/audio-fwrite.rst | 80 +
.../linux_tv/media/dvb/audio-get-capabilities.rst | 55 +
Documentation/linux_tv/media/dvb/audio-get-pts.rst | 64 +
.../linux_tv/media/dvb/audio-get-status.rst | 55 +
Documentation/linux_tv/media/dvb/audio-pause.rst | 50 +
Documentation/linux_tv/media/dvb/audio-play.rst | 49 +
.../linux_tv/media/dvb/audio-select-source.rst | 57 +
.../linux_tv/media/dvb/audio-set-attributes.rst | 69 +
.../linux_tv/media/dvb/audio-set-av-sync.rst | 65 +
.../linux_tv/media/dvb/audio-set-bypass-mode.rst | 69 +
.../linux_tv/media/dvb/audio-set-ext-id.rst | 69 +
Documentation/linux_tv/media/dvb/audio-set-id.rst | 60 +
.../linux_tv/media/dvb/audio-set-karaoke.rst | 65 +
.../linux_tv/media/dvb/audio-set-mixer.rst | 54 +
.../linux_tv/media/dvb/audio-set-mute.rst | 69 +
.../linux_tv/media/dvb/audio-set-streamtype.rst | 70 +
Documentation/linux_tv/media/dvb/audio-stop.rst | 49 +
.../linux_tv/media/dvb/audio_function_calls.rst | 1399 +-------------
Documentation/linux_tv/media/dvb/ca-fclose.rst | 52 +
Documentation/linux_tv/media/dvb/ca-fopen.rst | 107 ++
Documentation/linux_tv/media/dvb/ca-get-cap.rst | 54 +
.../linux_tv/media/dvb/ca-get-descr-info.rst | 54 +
Documentation/linux_tv/media/dvb/ca-get-msg.rst | 54 +
.../linux_tv/media/dvb/ca-get-slot-info.rst | 54 +
Documentation/linux_tv/media/dvb/ca-reset.rst | 48 +
Documentation/linux_tv/media/dvb/ca-send-msg.rst | 54 +
Documentation/linux_tv/media/dvb/ca-set-descr.rst | 54 +
Documentation/linux_tv/media/dvb/ca-set-pid.rst | 52 +
.../linux_tv/media/dvb/ca_function_calls.rst | 577 +-----
Documentation/linux_tv/media/dvb/dmx-add-pid.rst | 56 +
Documentation/linux_tv/media/dvb/dmx-fclose.rst | 53 +
Documentation/linux_tv/media/dvb/dmx-fopen.rst | 106 ++
Documentation/linux_tv/media/dvb/dmx-fread.rst | 106 ++
Documentation/linux_tv/media/dvb/dmx-fwrite.rst | 87 +
Documentation/linux_tv/media/dvb/dmx-get-caps.rst | 54 +
Documentation/linux_tv/media/dvb/dmx-get-event.rst | 72 +
.../linux_tv/media/dvb/dmx-get-pes-pids.rst | 54 +
Documentation/linux_tv/media/dvb/dmx-get-stc.rst | 73 +
.../linux_tv/media/dvb/dmx-remove-pid.rst | 55 +
.../linux_tv/media/dvb/dmx-set-buffer-size.rst | 57 +
.../linux_tv/media/dvb/dmx-set-filter.rst | 63 +
.../linux_tv/media/dvb/dmx-set-pes-filter.rst | 74 +
.../linux_tv/media/dvb/dmx-set-source.rst | 54 +
Documentation/linux_tv/media/dvb/dmx-start.rst | 73 +
Documentation/linux_tv/media/dvb/dmx-stop.rst | 50 +
Documentation/linux_tv/media/dvb/dmx_fcalls.rst | 1075 +----------
Documentation/linux_tv/media/dvb/net-add-if.rst | 87 +
Documentation/linux_tv/media/dvb/net-get-if.rst | 48 +
Documentation/linux_tv/media/dvb/net-remove-if.rst | 42 +
Documentation/linux_tv/media/dvb/net.rst | 180 +-
.../linux_tv/media/dvb/video-clear-buffer.rst | 49 +
Documentation/linux_tv/media/dvb/video-command.rst | 61 +
.../linux_tv/media/dvb/video-continue.rst | 52 +
.../linux_tv/media/dvb/video-fast-forward.rst | 70 +
Documentation/linux_tv/media/dvb/video-fclose.rst | 52 +
Documentation/linux_tv/media/dvb/video-fopen.rst | 108 ++
Documentation/linux_tv/media/dvb/video-freeze.rst | 56 +
Documentation/linux_tv/media/dvb/video-fwrite.rst | 80 +
.../linux_tv/media/dvb/video-get-capabilities.rst | 56 +
.../linux_tv/media/dvb/video-get-event.rst | 86 +
.../linux_tv/media/dvb/video-get-frame-count.rst | 60 +
.../linux_tv/media/dvb/video-get-frame-rate.rst | 54 +
.../linux_tv/media/dvb/video-get-navi.rst | 70 +
Documentation/linux_tv/media/dvb/video-get-pts.rst | 64 +
.../linux_tv/media/dvb/video-get-size.rst | 54 +
.../linux_tv/media/dvb/video-get-status.rst | 55 +
Documentation/linux_tv/media/dvb/video-play.rst | 52 +
.../linux_tv/media/dvb/video-select-source.rst | 60 +
.../linux_tv/media/dvb/video-set-attributes.rst | 68 +
.../linux_tv/media/dvb/video-set-blank.rst | 59 +
.../media/dvb/video-set-display-format.rst | 55 +
.../linux_tv/media/dvb/video-set-format.rst | 70 +
.../linux_tv/media/dvb/video-set-highlight.rst | 55 +
Documentation/linux_tv/media/dvb/video-set-id.rst | 69 +
.../linux_tv/media/dvb/video-set-spu-palette.rst | 68 +
Documentation/linux_tv/media/dvb/video-set-spu.rst | 70 +
.../linux_tv/media/dvb/video-set-streamtype.rst | 56 +
.../linux_tv/media/dvb/video-set-system.rst | 71 +
.../linux_tv/media/dvb/video-slowmotion.rst | 70 +
.../linux_tv/media/dvb/video-stillpicture.rst | 56 +
Documentation/linux_tv/media/dvb/video-stop.rst | 69 +
.../linux_tv/media/dvb/video-try-command.rst | 61 +
.../linux_tv/media/dvb/video_function_calls.rst | 2008 +-------------------
89 files changed, 5399 insertions(+), 5141 deletions(-)
create mode 100644 Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-channel-select.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-continue.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-fwrite.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-get-pts.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-get-status.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-pause.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-play.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-select-source.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-attributes.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-id.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-mixer.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-mute.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
create mode 100644 Documentation/linux_tv/media/dvb/audio-stop.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-cap.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-msg.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-reset.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-send-msg.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-set-descr.rst
create mode 100644 Documentation/linux_tv/media/dvb/ca-set-pid.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-add-pid.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fread.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-fwrite.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-caps.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-event.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-get-stc.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-filter.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-set-source.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-start.rst
create mode 100644 Documentation/linux_tv/media/dvb/dmx-stop.rst
create mode 100644 Documentation/linux_tv/media/dvb/net-add-if.rst
create mode 100644 Documentation/linux_tv/media/dvb/net-get-if.rst
create mode 100644 Documentation/linux_tv/media/dvb/net-remove-if.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-clear-buffer.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-command.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-continue.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fast-forward.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fclose.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fopen.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-freeze.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-fwrite.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-capabilities.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-event.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-frame-count.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-navi.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-pts.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-size.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-get-status.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-play.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-select-source.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-attributes.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-blank.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-display-format.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-format.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-highlight.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-id.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-spu.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-streamtype.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-set-system.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-slowmotion.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-stillpicture.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-stop.rst
create mode 100644 Documentation/linux_tv/media/dvb/video-try-command.rst
diff --git a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
new file mode 100644
index 000000000000..b965932fe20c
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
@@ -0,0 +1,59 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_BILINGUAL_CHANNEL_SELECT:
+
+AUDIO_BILINGUAL_CHANNEL_SELECT
+==============================
+
+Description
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. It has been replaced
+by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control
+for MPEG decoders controlled through V4L2.
+
+This ioctl call asks the Audio Device to select the requested channel
+for bilingual streams if possible.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_BILINGUAL_CHANNEL_SELECT for this command.
+
+ - .. row 3
+
+ - audio_channel_select_t ch
+
+ - Select the output format of the audio (mono left/right, stereo).
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
new file mode 100644
index 000000000000..d570ff1f7d3a
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
@@ -0,0 +1,58 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_CHANNEL_SELECT:
+
+AUDIO_CHANNEL_SELECT
+====================
+
+Description
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
+
+This ioctl call asks the Audio Device to select the requested channel if
+possible.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_CHANNEL_SELECT for this command.
+
+ - .. row 3
+
+ - audio_channel_select_t ch
+
+ - Select the output format of the audio (mono left/right, stereo).
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
new file mode 100644
index 000000000000..6c94cc7402a9
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
@@ -0,0 +1,49 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_CLEAR_BUFFER:
+
+AUDIO_CLEAR_BUFFER
+==================
+
+Description
+-----------
+
+This ioctl call asks the Audio Device to clear all software and hardware
+buffers of the audio decoder device.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_CLEAR_BUFFER for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-continue.rst b/Documentation/linux_tv/media/dvb/audio-continue.rst
new file mode 100644
index 000000000000..8b91cf950765
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-continue.rst
@@ -0,0 +1,49 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_CONTINUE:
+
+AUDIO_CONTINUE
+==============
+
+Description
+-----------
+
+This ioctl restarts the decoding and playing process previously paused
+with AUDIO_PAUSE command.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_CONTINUE for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-fclose.rst b/Documentation/linux_tv/media/dvb/audio-fclose.rst
new file mode 100644
index 000000000000..fb855dd9cbcb
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-fclose.rst
@@ -0,0 +1,52 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _audio_fclose:
+
+DVB audio close()
+=================
+
+Description
+-----------
+
+This system call closes a previously opened audio device.
+
+Synopsis
+--------
+
+.. c:function:: int close(int fd)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-fopen.rst b/Documentation/linux_tv/media/dvb/audio-fopen.rst
new file mode 100644
index 000000000000..5d3d7d941567
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-fopen.rst
@@ -0,0 +1,102 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _audio_fopen:
+
+DVB audio open()
+================
+
+Description
+-----------
+
+This system call opens a named audio device (e.g.
+/dev/dvb/adapter0/audio0) for subsequent use. When an open() call has
+succeeded, the device will be ready for use. The significance of
+blocking or non-blocking mode is described in the documentation for
+functions where there is a difference. It does not affect the semantics
+of the open() call itself. A device opened in blocking mode can later be
+put into non-blocking mode (and vice versa) using the F_SETFL command
+of the fcntl system call. This is a standard system call, documented in
+the Linux manual page for fcntl. Only one user can open the Audio Device
+in O_RDWR mode. All other attempts to open the device in this mode will
+fail, and an error code will be returned. If the Audio Device is opened
+in O_RDONLY mode, the only ioctl call that can be used is
+AUDIO_GET_STATUS. All other call will return with an error code.
+
+Synopsis
+--------
+
+.. c:function:: int open(const char *deviceName, int flags)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - const char \*deviceName
+
+ - Name of specific audio device.
+
+ - .. row 2
+
+ - int flags
+
+ - A bit-wise OR of the following flags:
+
+ - .. row 3
+
+ -
+ - O_RDONLY read-only access
+
+ - .. row 4
+
+ -
+ - O_RDWR read/write access
+
+ - .. row 5
+
+ -
+ - O_NONBLOCK open in non-blocking mode
+
+ - .. row 6
+
+ -
+ - (blocking mode is the default)
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``ENODEV``
+
+ - Device driver not loaded/available.
+
+ - .. row 2
+
+ - ``EBUSY``
+
+ - Device or resource busy.
+
+ - .. row 3
+
+ - ``EINVAL``
+
+ - Invalid argument.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-fwrite.rst b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
new file mode 100644
index 000000000000..9921f3a16d45
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
@@ -0,0 +1,80 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _audio_fwrite:
+
+DVB audio write()
+=================
+
+Description
+-----------
+
+This system call can only be used if AUDIO_SOURCE_MEMORY is selected
+in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in
+PES format. If O_NONBLOCK is not specified the function will block
+until buffer space is available. The amount of data to be transferred is
+implied by count.
+
+Synopsis
+--------
+
+.. c:function:: size_t write(int fd, const void *buf, size_t count)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - void \*buf
+
+ - Pointer to the buffer containing the PES data.
+
+ - .. row 3
+
+ - size_t count
+
+ - Size of buf.
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EPERM``
+
+ - Mode AUDIO_SOURCE_MEMORY not selected.
+
+ - .. row 2
+
+ - ``ENOMEM``
+
+ - Attempted to write more data than the internal buffer can hold.
+
+ - .. row 3
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
new file mode 100644
index 000000000000..84b9f073344b
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
@@ -0,0 +1,55 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_GET_CAPABILITIES:
+
+AUDIO_GET_CAPABILITIES
+======================
+
+Description
+-----------
+
+This ioctl call asks the Audio Device to tell us about the decoding
+capabilities of the audio hardware.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_GET_CAPABILITIES for this command.
+
+ - .. row 3
+
+ - unsigned int \*cap
+
+ - Returns a bit array of supported sound formats.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-get-pts.rst b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
new file mode 100644
index 000000000000..3cd31741e728
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
@@ -0,0 +1,64 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_GET_PTS:
+
+AUDIO_GET_PTS
+=============
+
+Description
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. If you need this
+functionality, then please contact the linux-media mailing list
+(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__).
+
+This ioctl call asks the Audio Device to return the current PTS
+timestamp.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_GET_PTS for this command.
+
+ - .. row 3
+
+ - __u64 \*pts
+
+ - Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
+ ISO/IEC 13818-1.
+
+ The PTS should belong to the currently played frame if possible,
+ but may also be a value close to it like the PTS of the last
+ decoded frame or the last PTS extracted by the PES parser.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-get-status.rst b/Documentation/linux_tv/media/dvb/audio-get-status.rst
new file mode 100644
index 000000000000..be0937fbff0c
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-get-status.rst
@@ -0,0 +1,55 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_GET_STATUS:
+
+AUDIO_GET_STATUS
+================
+
+Description
+-----------
+
+This ioctl call asks the Audio Device to return the current state of the
+Audio Device.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_GET_STATUS for this command.
+
+ - .. row 3
+
+ - struct audio_status \*status
+
+ - Returns the current state of Audio Device.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-pause.rst b/Documentation/linux_tv/media/dvb/audio-pause.rst
new file mode 100644
index 000000000000..2d1c7e880ad0
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-pause.rst
@@ -0,0 +1,50 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_PAUSE:
+
+AUDIO_PAUSE
+===========
+
+Description
+-----------
+
+This ioctl call suspends the audio stream being played. Decoding and
+playing are paused. It is then possible to restart again decoding and
+playing process of the audio stream using AUDIO_CONTINUE command.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_PAUSE for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-play.rst b/Documentation/linux_tv/media/dvb/audio-play.rst
new file mode 100644
index 000000000000..116cc27be82c
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-play.rst
@@ -0,0 +1,49 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_PLAY:
+
+AUDIO_PLAY
+==========
+
+Description
+-----------
+
+This ioctl call asks the Audio Device to start playing an audio stream
+from the selected source.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_PLAY for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-select-source.rst b/Documentation/linux_tv/media/dvb/audio-select-source.rst
new file mode 100644
index 000000000000..9d6367e7ff6f
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-select-source.rst
@@ -0,0 +1,57 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SELECT_SOURCE:
+
+AUDIO_SELECT_SOURCE
+===================
+
+Description
+-----------
+
+This ioctl call informs the audio device which source shall be used for
+the input data. The possible sources are demux or memory. If
+AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device
+through the write command.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SELECT_SOURCE for this command.
+
+ - .. row 3
+
+ - audio_stream_source_t source
+
+ - Indicates the source that shall be used for the Audio stream.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
new file mode 100644
index 000000000000..a03774015b40
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
@@ -0,0 +1,69 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_ATTRIBUTES:
+
+AUDIO_SET_ATTRIBUTES
+====================
+
+Description
+-----------
+
+This ioctl is intended for DVD playback and allows you to set certain
+information about the audio stream.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_ATTRIBUTES for this command.
+
+ - .. row 3
+
+ - audio_attributes_t attr
+
+ - audio attributes according to section ??
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - attr is not a valid or supported attribute setting.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
new file mode 100644
index 000000000000..7aa27ab34d91
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
@@ -0,0 +1,65 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_AV_SYNC:
+
+AUDIO_SET_AV_SYNC
+=================
+
+Description
+-----------
+
+This ioctl call asks the Audio Device to turn ON or OFF A/V
+synchronization.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_AV_SYNC for this command.
+
+ - .. row 3
+
+ - boolean state
+
+ - Tells the DVB subsystem if A/V synchronization shall be ON or OFF.
+
+ - .. row 4
+
+ -
+ - TRUE AV-sync ON
+
+ - .. row 5
+
+ -
+ - FALSE AV-sync OFF
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
new file mode 100644
index 000000000000..3a0c21a667fa
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
@@ -0,0 +1,69 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_BYPASS_MODE:
+
+AUDIO_SET_BYPASS_MODE
+=====================
+
+Description
+-----------
+
+This ioctl call asks the Audio Device to bypass the Audio decoder and
+forward the stream without decoding. This mode shall be used if streams
+that can’t be handled by the DVB system shall be decoded. Dolby
+DigitalTM streams are automatically forwarded by the DVB subsystem if
+the hardware can handle it.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_BYPASS_MODE for this command.
+
+ - .. row 3
+
+ - boolean mode
+
+ - Enables or disables the decoding of the current Audio stream in
+ the DVB subsystem.
+
+ - .. row 4
+
+ -
+ - TRUE Bypass is disabled
+
+ - .. row 5
+
+ -
+ - FALSE Bypass is enabled
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
new file mode 100644
index 000000000000..bda4c92df27f
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
@@ -0,0 +1,69 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_EXT_ID:
+
+AUDIO_SET_EXT_ID
+================
+
+Description
+-----------
+
+This ioctl can be used to set the extension id for MPEG streams in DVD
+playback. Only the first 3 bits are recognized.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_EXT_ID for this command.
+
+ - .. row 3
+
+ - int id
+
+ - audio sub_stream_id
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - id is not a valid id.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-id.rst b/Documentation/linux_tv/media/dvb/audio-set-id.rst
new file mode 100644
index 000000000000..e545f9dad407
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-id.rst
@@ -0,0 +1,60 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_ID:
+
+AUDIO_SET_ID
+============
+
+Description
+-----------
+
+This ioctl selects which sub-stream is to be decoded if a program or
+system stream is sent to the video device. If no audio stream type is
+set the id has to be in [0xC0,0xDF] for MPEG sound, in [0x80,0x87] for
+AC3 and in [0xA0,0xA7] for LPCM. More specifications may follow for
+other stream types. If the stream type is set the id just specifies the
+substream id of the audio stream and only the first 5 bits are
+recognized.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_ID for this command.
+
+ - .. row 3
+
+ - int id
+
+ - audio sub-stream id
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
new file mode 100644
index 000000000000..75a02e4db0a1
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
@@ -0,0 +1,65 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_KARAOKE:
+
+AUDIO_SET_KARAOKE
+=================
+
+Description
+-----------
+
+This ioctl allows one to set the mixer settings for a karaoke DVD.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_KARAOKE for this command.
+
+ - .. row 3
+
+ - audio_karaoke_t \*karaoke
+
+ - karaoke settings according to section ??.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - karaoke is not a valid or supported karaoke setting.
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
new file mode 100644
index 000000000000..9360d20e759e
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_MIXER:
+
+AUDIO_SET_MIXER
+===============
+
+Description
+-----------
+
+This ioctl lets you adjust the mixer settings of the audio decoder.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_ID for this command.
+
+ - .. row 3
+
+ - audio_mixer_t \*mix
+
+ - mixer settings.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mute.rst b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
new file mode 100644
index 000000000000..eb6622b63e2b
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
@@ -0,0 +1,69 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_MUTE:
+
+AUDIO_SET_MUTE
+==============
+
+Description
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` with the
+``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
+
+This ioctl call asks the audio device to mute the stream that is
+currently being played.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_MUTE for this command.
+
+ - .. row 3
+
+ - boolean state
+
+ - Indicates if audio device shall mute or not.
+
+ - .. row 4
+
+ -
+ - TRUE Audio Mute
+
+ - .. row 5
+
+ -
+ - FALSE Audio Un-mute
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
new file mode 100644
index 000000000000..6fc7c8dfccf8
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
@@ -0,0 +1,70 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_SET_STREAMTYPE:
+
+AUDIO_SET_STREAMTYPE
+====================
+
+Description
+-----------
+
+This ioctl tells the driver which kind of audio stream to expect. This
+is useful if the stream offers several audio sub-streams like LPCM and
+AC3.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_SET_STREAMTYPE for this command.
+
+ - .. row 3
+
+ - int type
+
+ - stream type
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - type is not a valid or supported stream type.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio-stop.rst b/Documentation/linux_tv/media/dvb/audio-stop.rst
new file mode 100644
index 000000000000..57e95c453350
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/audio-stop.rst
@@ -0,0 +1,49 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _AUDIO_STOP:
+
+AUDIO_STOP
+==========
+
+Description
+-----------
+
+This ioctl call asks the Audio Device to stop playing the current
+stream.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals AUDIO_STOP for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/audio_function_calls.rst b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
index 8eec97d836ea..0bb56f0cfed4 100644
--- a/Documentation/linux_tv/media/dvb/audio_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/audio_function_calls.rst
@@ -6,1376 +6,29 @@
Audio Function Calls
********************
-
-.. _audio_fopen:
-
-DVB audio open()
-================
-
-Description
------------
-
-This system call opens a named audio device (e.g.
-/dev/dvb/adapter0/audio0) for subsequent use. When an open() call has
-succeeded, the device will be ready for use. The significance of
-blocking or non-blocking mode is described in the documentation for
-functions where there is a difference. It does not affect the semantics
-of the open() call itself. A device opened in blocking mode can later be
-put into non-blocking mode (and vice versa) using the F_SETFL command
-of the fcntl system call. This is a standard system call, documented in
-the Linux manual page for fcntl. Only one user can open the Audio Device
-in O_RDWR mode. All other attempts to open the device in this mode will
-fail, and an error code will be returned. If the Audio Device is opened
-in O_RDONLY mode, the only ioctl call that can be used is
-AUDIO_GET_STATUS. All other call will return with an error code.
-
-Synopsis
---------
-
-.. c:function:: int open(const char *deviceName, int flags)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - const char \*deviceName
-
- - Name of specific audio device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDONLY read-only access
-
- - .. row 4
-
- -
- - O_RDWR read/write access
-
- - .. row 5
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 6
-
- -
- - (blocking mode is the default)
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``ENODEV``
-
- - Device driver not loaded/available.
-
- - .. row 2
-
- - ``EBUSY``
-
- - Device or resource busy.
-
- - .. row 3
-
- - ``EINVAL``
-
- - Invalid argument.
-
-
-
-.. _audio_fclose:
-
-DVB audio close()
-=================
-
-Description
------------
-
-This system call closes a previously opened audio device.
-
-Synopsis
---------
-
-.. c:function:: int close(int fd)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
-
-
-.. _audio_fwrite:
-
-DVB audio write()
-=================
-
-Description
------------
-
-This system call can only be used if AUDIO_SOURCE_MEMORY is selected
-in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in
-PES format. If O_NONBLOCK is not specified the function will block
-until buffer space is available. The amount of data to be transferred is
-implied by count.
-
-Synopsis
---------
-
-.. c:function:: size_t write(int fd, const void *buf, size_t count)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - void \*buf
-
- - Pointer to the buffer containing the PES data.
-
- - .. row 3
-
- - size_t count
-
- - Size of buf.
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EPERM``
-
- - Mode AUDIO_SOURCE_MEMORY not selected.
-
- - .. row 2
-
- - ``ENOMEM``
-
- - Attempted to write more data than the internal buffer can hold.
-
- - .. row 3
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
-
-
-.. _AUDIO_STOP:
-
-AUDIO_STOP
-==========
-
-Description
------------
-
-This ioctl call asks the Audio Device to stop playing the current
-stream.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_STOP for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_PLAY:
-
-AUDIO_PLAY
-==========
-
-Description
------------
-
-This ioctl call asks the Audio Device to start playing an audio stream
-from the selected source.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_PLAY for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_PAUSE:
-
-AUDIO_PAUSE
-===========
-
-Description
------------
-
-This ioctl call suspends the audio stream being played. Decoding and
-playing are paused. It is then possible to restart again decoding and
-playing process of the audio stream using AUDIO_CONTINUE command.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_PAUSE for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_CONTINUE:
-
-AUDIO_CONTINUE
-==============
-
-Description
------------
-
-This ioctl restarts the decoding and playing process previously paused
-with AUDIO_PAUSE command.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_CONTINUE for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_SELECT_SOURCE:
-
-AUDIO_SELECT_SOURCE
-===================
-
-Description
------------
-
-This ioctl call informs the audio device which source shall be used for
-the input data. The possible sources are demux or memory. If
-AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device
-through the write command.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SELECT_SOURCE for this command.
-
- - .. row 3
-
- - audio_stream_source_t source
-
- - Indicates the source that shall be used for the Audio stream.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_SET_MUTE:
-
-AUDIO_SET_MUTE
-==============
-
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` with the
-``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
-
-This ioctl call asks the audio device to mute the stream that is
-currently being played.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_MUTE for this command.
-
- - .. row 3
-
- - boolean state
-
- - Indicates if audio device shall mute or not.
-
- - .. row 4
-
- -
- - TRUE Audio Mute
-
- - .. row 5
-
- -
- - FALSE Audio Un-mute
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_SET_AV_SYNC:
-
-AUDIO_SET_AV_SYNC
-=================
-
-Description
------------
-
-This ioctl call asks the Audio Device to turn ON or OFF A/V
-synchronization.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_AV_SYNC for this command.
-
- - .. row 3
-
- - boolean state
-
- - Tells the DVB subsystem if A/V synchronization shall be ON or OFF.
-
- - .. row 4
-
- -
- - TRUE AV-sync ON
-
- - .. row 5
-
- -
- - FALSE AV-sync OFF
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_SET_BYPASS_MODE:
-
-AUDIO_SET_BYPASS_MODE
-=====================
-
-Description
------------
-
-This ioctl call asks the Audio Device to bypass the Audio decoder and
-forward the stream without decoding. This mode shall be used if streams
-that can’t be handled by the DVB system shall be decoded. Dolby
-DigitalTM streams are automatically forwarded by the DVB subsystem if
-the hardware can handle it.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_BYPASS_MODE for this command.
-
- - .. row 3
-
- - boolean mode
-
- - Enables or disables the decoding of the current Audio stream in
- the DVB subsystem.
-
- - .. row 4
-
- -
- - TRUE Bypass is disabled
-
- - .. row 5
-
- -
- - FALSE Bypass is enabled
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_CHANNEL_SELECT:
-
-AUDIO_CHANNEL_SELECT
-====================
-
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
-
-This ioctl call asks the Audio Device to select the requested channel if
-possible.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_CHANNEL_SELECT for this command.
-
- - .. row 3
-
- - audio_channel_select_t ch
-
- - Select the output format of the audio (mono left/right, stereo).
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_BILINGUAL_CHANNEL_SELECT:
-
-AUDIO_BILINGUAL_CHANNEL_SELECT
-==============================
-
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. It has been replaced
-by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control
-for MPEG decoders controlled through V4L2.
-
-This ioctl call asks the Audio Device to select the requested channel
-for bilingual streams if possible.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_BILINGUAL_CHANNEL_SELECT for this command.
-
- - .. row 3
-
- - audio_channel_select_t ch
-
- - Select the output format of the audio (mono left/right, stereo).
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_GET_PTS:
-
-AUDIO_GET_PTS
-=============
-
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. If you need this
-functionality, then please contact the linux-media mailing list
-(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__).
-
-This ioctl call asks the Audio Device to return the current PTS
-timestamp.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_GET_PTS for this command.
-
- - .. row 3
-
- - __u64 \*pts
-
- - Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
- ISO/IEC 13818-1.
-
- The PTS should belong to the currently played frame if possible,
- but may also be a value close to it like the PTS of the last
- decoded frame or the last PTS extracted by the PES parser.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_GET_STATUS:
-
-AUDIO_GET_STATUS
-================
-
-Description
------------
-
-This ioctl call asks the Audio Device to return the current state of the
-Audio Device.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_GET_STATUS for this command.
-
- - .. row 3
-
- - struct audio_status \*status
-
- - Returns the current state of Audio Device.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_GET_CAPABILITIES:
-
-AUDIO_GET_CAPABILITIES
-======================
-
-Description
------------
-
-This ioctl call asks the Audio Device to tell us about the decoding
-capabilities of the audio hardware.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_GET_CAPABILITIES for this command.
-
- - .. row 3
-
- - unsigned int \*cap
-
- - Returns a bit array of supported sound formats.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_CLEAR_BUFFER:
-
-AUDIO_CLEAR_BUFFER
-==================
-
-Description
------------
-
-This ioctl call asks the Audio Device to clear all software and hardware
-buffers of the audio decoder device.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_CLEAR_BUFFER for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_SET_ID:
-
-AUDIO_SET_ID
-============
-
-Description
------------
-
-This ioctl selects which sub-stream is to be decoded if a program or
-system stream is sent to the video device. If no audio stream type is
-set the id has to be in [0xC0,0xDF] for MPEG sound, in [0x80,0x87] for
-AC3 and in [0xA0,0xA7] for LPCM. More specifications may follow for
-other stream types. If the stream type is set the id just specifies the
-substream id of the audio stream and only the first 5 bits are
-recognized.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_ID for this command.
-
- - .. row 3
-
- - int id
-
- - audio sub-stream id
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_SET_MIXER:
-
-AUDIO_SET_MIXER
-===============
-
-Description
------------
-
-This ioctl lets you adjust the mixer settings of the audio decoder.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_ID for this command.
-
- - .. row 3
-
- - audio_mixer_t \*mix
-
- - mixer settings.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _AUDIO_SET_STREAMTYPE:
-
-AUDIO_SET_STREAMTYPE
-====================
-
-Description
------------
-
-This ioctl tells the driver which kind of audio stream to expect. This
-is useful if the stream offers several audio sub-streams like LPCM and
-AC3.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_STREAMTYPE for this command.
-
- - .. row 3
-
- - int type
-
- - stream type
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - type is not a valid or supported stream type.
-
-
-
-.. _AUDIO_SET_EXT_ID:
-
-AUDIO_SET_EXT_ID
-================
-
-Description
------------
-
-This ioctl can be used to set the extension id for MPEG streams in DVD
-playback. Only the first 3 bits are recognized.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_EXT_ID for this command.
-
- - .. row 3
-
- - int id
-
- - audio sub_stream_id
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - id is not a valid id.
-
-
-
-.. _AUDIO_SET_ATTRIBUTES:
-
-AUDIO_SET_ATTRIBUTES
-====================
-
-Description
------------
-
-This ioctl is intended for DVD playback and allows you to set certain
-information about the audio stream.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_ATTRIBUTES for this command.
-
- - .. row 3
-
- - audio_attributes_t attr
-
- - audio attributes according to section ??
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - attr is not a valid or supported attribute setting.
-
-
-
-.. _AUDIO_SET_KARAOKE:
-
-AUDIO_SET_KARAOKE
-=================
-
-Description
------------
-
-This ioctl allows one to set the mixer settings for a karaoke DVD.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals AUDIO_SET_KARAOKE for this command.
-
- - .. row 3
-
- - audio_karaoke_t \*karaoke
-
- - karaoke settings according to section ??.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - karaoke is not a valid or supported karaoke setting.
+.. toctree::
+ :maxdepth: 1
+
+ audio-fopen
+ audio-fclose
+ audio-fwrite
+ audio-stop
+ audio-play
+ audio-pause
+ audio-continue
+ audio-select-source
+ audio-set-mute
+ audio-set-av-sync
+ audio-set-bypass-mode
+ audio-channel-select
+ audio-bilingual-channel-select
+ audio-get-pts
+ audio-get-status
+ audio-get-capabilities
+ audio-clear-buffer
+ audio-set-id
+ audio-set-mixer
+ audio-set-streamtype
+ audio-set-ext-id
+ audio-set-attributes
+ audio-set-karaoke
diff --git a/Documentation/linux_tv/media/dvb/ca-fclose.rst b/Documentation/linux_tv/media/dvb/ca-fclose.rst
new file mode 100644
index 000000000000..c7797c726c6b
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-fclose.rst
@@ -0,0 +1,52 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _ca_fclose:
+
+DVB CA close()
+==============
+
+Description
+-----------
+
+This system call closes a previously opened audio device.
+
+Synopsis
+--------
+
+.. cpp:function:: int close(int fd)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-fopen.rst b/Documentation/linux_tv/media/dvb/ca-fopen.rst
new file mode 100644
index 000000000000..316209439f88
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-fopen.rst
@@ -0,0 +1,107 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _ca_fopen:
+
+DVB CA open()
+=============
+
+Description
+-----------
+
+This system call opens a named ca device (e.g. /dev/ost/ca) for
+subsequent use.
+
+When an open() call has succeeded, the device will be ready for use. The
+significance of blocking or non-blocking mode is described in the
+documentation for functions where there is a difference. It does not
+affect the semantics of the open() call itself. A device opened in
+blocking mode can later be put into non-blocking mode (and vice versa)
+using the F_SETFL command of the fcntl system call. This is a standard
+system call, documented in the Linux manual page for fcntl. Only one
+user can open the CA Device in O_RDWR mode. All other attempts to open
+the device in this mode will fail, and an error code will be returned.
+
+Synopsis
+--------
+
+.. cpp:function:: int open(const char *deviceName, int flags)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - const char \*deviceName
+
+ - Name of specific video device.
+
+ - .. row 2
+
+ - int flags
+
+ - A bit-wise OR of the following flags:
+
+ - .. row 3
+
+ -
+ - O_RDONLY read-only access
+
+ - .. row 4
+
+ -
+ - O_RDWR read/write access
+
+ - .. row 5
+
+ -
+ - O_NONBLOCK open in non-blocking mode
+
+ - .. row 6
+
+ -
+ - (blocking mode is the default)
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``ENODEV``
+
+ - Device driver not loaded/available.
+
+ - .. row 2
+
+ - ``EINTERNAL``
+
+ - Internal error.
+
+ - .. row 3
+
+ - ``EBUSY``
+
+ - Device or resource busy.
+
+ - .. row 4
+
+ - ``EINVAL``
+
+ - Invalid argument.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-get-cap.rst b/Documentation/linux_tv/media/dvb/ca-get-cap.rst
new file mode 100644
index 000000000000..9155e0b445ff
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-get-cap.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_GET_CAP:
+
+CA_GET_CAP
+==========
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_GET_CAP for this command.
+
+ - .. row 3
+
+ - ca_caps_t *
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
new file mode 100644
index 000000000000..cf5e3b1d8358
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_GET_DESCR_INFO:
+
+CA_GET_DESCR_INFO
+=================
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_GET_DESCR_INFO for this command.
+
+ - .. row 3
+
+ - ca_descr_info_t \*
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-get-msg.rst b/Documentation/linux_tv/media/dvb/ca-get-msg.rst
new file mode 100644
index 000000000000..994d73a59992
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-get-msg.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_GET_MSG:
+
+CA_GET_MSG
+==========
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_GET_MSG for this command.
+
+ - .. row 3
+
+ - ca_msg_t \*
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
new file mode 100644
index 000000000000..8c123aaf5538
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_GET_SLOT_INFO:
+
+CA_GET_SLOT_INFO
+================
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_GET_SLOT_INFO for this command.
+
+ - .. row 3
+
+ - ca_slot_info_t \*
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-reset.rst b/Documentation/linux_tv/media/dvb/ca-reset.rst
new file mode 100644
index 000000000000..4fa2597ea983
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-reset.rst
@@ -0,0 +1,48 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_RESET:
+
+CA_RESET
+========
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_RESET)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_RESET for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-send-msg.rst b/Documentation/linux_tv/media/dvb/ca-send-msg.rst
new file mode 100644
index 000000000000..cb9249561d8a
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-send-msg.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_SEND_MSG:
+
+CA_SEND_MSG
+===========
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_SEND_MSG for this command.
+
+ - .. row 3
+
+ - ca_msg_t \*
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-set-descr.rst b/Documentation/linux_tv/media/dvb/ca-set-descr.rst
new file mode 100644
index 000000000000..5b56e414da24
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-set-descr.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_SET_DESCR:
+
+CA_SET_DESCR
+============
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_SET_DESCR for this command.
+
+ - .. row 3
+
+ - ca_descr_t \*
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/ca-set-pid.rst b/Documentation/linux_tv/media/dvb/ca-set-pid.rst
new file mode 100644
index 000000000000..3d4b7e823c15
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/ca-set-pid.rst
@@ -0,0 +1,52 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _CA_SET_PID:
+
+CA_SET_PID
+==========
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals CA_SET_PID for this command.
+
+ - .. row 3
+
+ - ca_pid_t \*
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/ca_function_calls.rst b/Documentation/linux_tv/media/dvb/ca_function_calls.rst
index 754e612de70f..c085a0ebbc05 100644
--- a/Documentation/linux_tv/media/dvb/ca_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/ca_function_calls.rst
@@ -6,567 +6,16 @@
CA Function Calls
*****************
-
-.. _ca_fopen:
-
-DVB CA open()
-=============
-
-Description
------------
-
-This system call opens a named ca device (e.g. /dev/ost/ca) for
-subsequent use.
-
-When an open() call has succeeded, the device will be ready for use. The
-significance of blocking or non-blocking mode is described in the
-documentation for functions where there is a difference. It does not
-affect the semantics of the open() call itself. A device opened in
-blocking mode can later be put into non-blocking mode (and vice versa)
-using the F_SETFL command of the fcntl system call. This is a standard
-system call, documented in the Linux manual page for fcntl. Only one
-user can open the CA Device in O_RDWR mode. All other attempts to open
-the device in this mode will fail, and an error code will be returned.
-
-Synopsis
---------
-
-.. cpp:function:: int open(const char *deviceName, int flags)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - const char \*deviceName
-
- - Name of specific video device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDONLY read-only access
-
- - .. row 4
-
- -
- - O_RDWR read/write access
-
- - .. row 5
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 6
-
- -
- - (blocking mode is the default)
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``ENODEV``
-
- - Device driver not loaded/available.
-
- - .. row 2
-
- - ``EINTERNAL``
-
- - Internal error.
-
- - .. row 3
-
- - ``EBUSY``
-
- - Device or resource busy.
-
- - .. row 4
-
- - ``EINVAL``
-
- - Invalid argument.
-
-
-
-.. _ca_fclose:
-
-DVB CA close()
-==============
-
-Description
------------
-
-This system call closes a previously opened audio device.
-
-Synopsis
---------
-
-.. cpp:function:: int close(int fd)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
-
-
-.. _CA_RESET:
-
-CA_RESET
-========
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_RESET)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_RESET for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _CA_GET_CAP:
-
-CA_GET_CAP
-==========
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_GET_CAP for this command.
-
- - .. row 3
-
- - ca_caps_t *
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _CA_GET_SLOT_INFO:
-
-CA_GET_SLOT_INFO
-================
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_GET_SLOT_INFO for this command.
-
- - .. row 3
-
- - ca_slot_info_t \*
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _CA_GET_DESCR_INFO:
-
-CA_GET_DESCR_INFO
-=================
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_GET_DESCR_INFO for this command.
-
- - .. row 3
-
- - ca_descr_info_t \*
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _CA_GET_MSG:
-
-CA_GET_MSG
-==========
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_GET_MSG for this command.
-
- - .. row 3
-
- - ca_msg_t \*
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _CA_SEND_MSG:
-
-CA_SEND_MSG
-===========
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_SEND_MSG for this command.
-
- - .. row 3
-
- - ca_msg_t \*
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _CA_SET_DESCR:
-
-CA_SET_DESCR
-============
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_SET_DESCR for this command.
-
- - .. row 3
-
- - ca_descr_t \*
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _CA_SET_PID:
-
-CA_SET_PID
-==========
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals CA_SET_PID for this command.
-
- - .. row 3
-
- - ca_pid_t \*
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+.. toctree::
+ :maxdepth: 1
+
+ ca-fopen
+ ca-fclose
+ ca-reset
+ ca-get-cap
+ ca-get-slot-info
+ ca-get-descr-info
+ ca-get-msg
+ ca-send-msg
+ ca-set-descr
+ ca-set-pid
diff --git a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
new file mode 100644
index 000000000000..d6fd0a351a51
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
@@ -0,0 +1,56 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_ADD_PID:
+
+DMX_ADD_PID
+===========
+
+Description
+-----------
+
+This ioctl call allows to add multiple PIDs to a transport stream filter
+previously set up with DMX_SET_PES_FILTER and output equal to
+DMX_OUT_TSDEMUX_TAP.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_ADD_PID for this command.
+
+ - .. row 3
+
+ - __u16 *
+
+ - PID number to be filtered.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-fclose.rst b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
new file mode 100644
index 000000000000..079e944b8fc8
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
@@ -0,0 +1,53 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _dmx_fclose:
+
+DVB demux close()
+=================
+
+Description
+-----------
+
+This system call deactivates and deallocates a filter that was
+previously allocated via the open() call.
+
+Synopsis
+--------
+
+.. c:function:: int close(int fd)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-fopen.rst b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
new file mode 100644
index 000000000000..9d6d84d7b608
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
@@ -0,0 +1,106 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _dmx_fopen:
+
+DVB demux open()
+================
+
+Description
+-----------
+
+This system call, used with a device name of /dev/dvb/adapter0/demux0,
+allocates a new filter and returns a handle which can be used for
+subsequent control of that filter. This call has to be made for each
+filter to be used, i.e. every returned file descriptor is a reference to
+a single filter. /dev/dvb/adapter0/dvr0 is a logical device to be used
+for retrieving Transport Streams for digital video recording. When
+reading from this device a transport stream containing the packets from
+all PES filters set in the corresponding demux device
+(/dev/dvb/adapter0/demux0) having the output set to DMX_OUT_TS_TAP. A
+recorded Transport Stream is replayed by writing to this device.
+
+The significance of blocking or non-blocking mode is described in the
+documentation for functions where there is a difference. It does not
+affect the semantics of the open() call itself. A device opened in
+blocking mode can later be put into non-blocking mode (and vice versa)
+using the F_SETFL command of the fcntl system call.
+
+Synopsis
+--------
+
+.. c:function:: int open(const char *deviceName, int flags)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - const char \*deviceName
+
+ - Name of demux device.
+
+ - .. row 2
+
+ - int flags
+
+ - A bit-wise OR of the following flags:
+
+ - .. row 3
+
+ -
+ - O_RDWR read/write access
+
+ - .. row 4
+
+ -
+ - O_NONBLOCK open in non-blocking mode
+
+ - .. row 5
+
+ -
+ - (blocking mode is the default)
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``ENODEV``
+
+ - Device driver not loaded/available.
+
+ - .. row 2
+
+ - ``EINVAL``
+
+ - Invalid argument.
+
+ - .. row 3
+
+ - ``EMFILE``
+
+ - “Too many open files”, i.e. no more filters available.
+
+ - .. row 4
+
+ - ``ENOMEM``
+
+ - The driver failed to allocate enough memory.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-fread.rst b/Documentation/linux_tv/media/dvb/dmx-fread.rst
new file mode 100644
index 000000000000..66811dbe6dac
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-fread.rst
@@ -0,0 +1,106 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _dmx_fread:
+
+DVB demux read()
+================
+
+Description
+-----------
+
+This system call returns filtered data, which might be section or PES
+data. The filtered data is transferred from the driver’s internal
+circular buffer to buf. The maximum amount of data to be transferred is
+implied by count.
+
+Synopsis
+--------
+
+.. c:function:: size_t read(int fd, void *buf, size_t count)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - void \*buf
+
+ - Pointer to the buffer to be used for returned filtered data.
+
+ - .. row 3
+
+ - size_t count
+
+ - Size of buf.
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EWOULDBLOCK``
+
+ - No data to return and O_NONBLOCK was specified.
+
+ - .. row 2
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+ - .. row 3
+
+ - ``ECRC``
+
+ - Last section had a CRC error - no data returned. The buffer is
+ flushed.
+
+ - .. row 4
+
+ - ``EOVERFLOW``
+
+ -
+
+ - .. row 5
+
+ -
+ - The filtered data was not read from the buffer in due time,
+ resulting in non-read data being lost. The buffer is flushed.
+
+ - .. row 6
+
+ - ``ETIMEDOUT``
+
+ - The section was not loaded within the stated timeout period. See
+ ioctl DMX_SET_FILTER for how to set a timeout.
+
+ - .. row 7
+
+ - ``EFAULT``
+
+ - The driver failed to write to the callers buffer due to an invalid
+ \*buf pointer.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
new file mode 100644
index 000000000000..57aef82c77b2
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
@@ -0,0 +1,87 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _dmx_fwrite:
+
+DVB demux write()
+=================
+
+Description
+-----------
+
+This system call is only provided by the logical device
+/dev/dvb/adapter0/dvr0, associated with the physical demux device that
+provides the actual DVR functionality. It is used for replay of a
+digitally recorded Transport Stream. Matching filters have to be defined
+in the corresponding physical demux device, /dev/dvb/adapter0/demux0.
+The amount of data to be transferred is implied by count.
+
+Synopsis
+--------
+
+.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - void \*buf
+
+ - Pointer to the buffer containing the Transport Stream.
+
+ - .. row 3
+
+ - size_t count
+
+ - Size of buf.
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EWOULDBLOCK``
+
+ - No data was written. This might happen if O_NONBLOCK was
+ specified and there is no more buffer space available (if
+ O_NONBLOCK is not specified the function will block until buffer
+ space is available).
+
+ - .. row 2
+
+ - ``EBUSY``
+
+ - This error code indicates that there are conflicting requests. The
+ corresponding demux device is setup to receive data from the
+ front- end. Make sure that these filters are stopped and that the
+ filters with input set to DMX_IN_DVR are started.
+
+ - .. row 3
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
new file mode 100644
index 000000000000..56bba7b3fc6c
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_GET_CAPS:
+
+DMX_GET_CAPS
+============
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_GET_CAPS for this command.
+
+ - .. row 3
+
+ - dmx_caps_t *
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-event.rst b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
new file mode 100644
index 000000000000..8664d43f4334
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
@@ -0,0 +1,72 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_GET_EVENT:
+
+DMX_GET_EVENT
+=============
+
+Description
+-----------
+
+This ioctl call returns an event if available. If an event is not
+available, the behavior depends on whether the device is in blocking or
+non-blocking mode. In the latter case, the call fails immediately with
+errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
+event becomes available.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_GET_EVENT for this command.
+
+ - .. row 3
+
+ - struct dmx_event \*ev
+
+ - Pointer to the location where the event is to be stored.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EWOULDBLOCK``
+
+ - There is no event pending, and the device is in non-blocking mode.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
new file mode 100644
index 000000000000..39d6ae6db620
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_GET_PES_PIDS:
+
+DMX_GET_PES_PIDS
+================
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_GET_PES_PIDS for this command.
+
+ - .. row 3
+
+ - __u16[5]
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
new file mode 100644
index 000000000000..6081d959b4ad
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
@@ -0,0 +1,73 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_GET_STC:
+
+DMX_GET_STC
+===========
+
+Description
+-----------
+
+This ioctl call returns the current value of the system time counter
+(which is driven by a PES filter of type DMX_PES_PCR). Some hardware
+supports more than one STC, so you must specify which one by setting the
+num field of stc before the ioctl (range 0...n). The result is returned
+in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
+the real 90kHz STC value is stc->stc / stc->base .
+
+Synopsis
+--------
+
+.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_GET_STC for this command.
+
+ - .. row 3
+
+ - struct dmx_stc \*stc
+
+ - Pointer to the location where the stc is to be stored.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - Invalid stc number.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
new file mode 100644
index 000000000000..9e38eb8db6f8
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
@@ -0,0 +1,55 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_REMOVE_PID:
+
+DMX_REMOVE_PID
+==============
+
+Description
+-----------
+
+This ioctl call allows to remove a PID when multiple PIDs are set on a
+transport stream filter, e. g. a filter previously set up with output
+equal to DMX_OUT_TSDEMUX_TAP, created via either
+DMX_SET_PES_FILTER or DMX_ADD_PID.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_REMOVE_PID for this command.
+
+ - .. row 3
+
+ - __u16 *
+
+ - PID of the PES filter to be removed.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
new file mode 100644
index 000000000000..a5074a6ac48e
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
@@ -0,0 +1,57 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_SET_BUFFER_SIZE:
+
+DMX_SET_BUFFER_SIZE
+===================
+
+Description
+-----------
+
+This ioctl call is used to set the size of the circular buffer used for
+filtered data. The default size is two maximum sized sections, i.e. if
+this function is not called a buffer size of 2 \* 4096 bytes will be
+used.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_SET_BUFFER_SIZE for this command.
+
+ - .. row 3
+
+ - unsigned long size
+
+ - Size of circular buffer.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
new file mode 100644
index 000000000000..548af600d635
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
@@ -0,0 +1,63 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_SET_FILTER:
+
+DMX_SET_FILTER
+==============
+
+Description
+-----------
+
+This ioctl call sets up a filter according to the filter and mask
+parameters provided. A timeout may be defined stating number of seconds
+to wait for a section to be loaded. A value of 0 means that no timeout
+should be applied. Finally there is a flag field where it is possible to
+state whether a section should be CRC-checked, whether the filter should
+be a ”one-shot” filter, i.e. if the filtering operation should be
+stopped after the first section is received, and whether the filtering
+operation should be started immediately (without waiting for a
+DMX_START ioctl call). If a filter was previously set-up, this filter
+will be canceled, and the receive buffer will be flushed.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_SET_FILTER for this command.
+
+ - .. row 3
+
+ - struct dmx_sct_filter_params \*params
+
+ - Pointer to structure containing filter parameters.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
new file mode 100644
index 000000000000..7d9b6dabc772
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
@@ -0,0 +1,74 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_SET_PES_FILTER:
+
+DMX_SET_PES_FILTER
+==================
+
+Description
+-----------
+
+This ioctl call sets up a PES filter according to the parameters
+provided. By a PES filter is meant a filter that is based just on the
+packet identifier (PID), i.e. no PES header or payload filtering
+capability is supported.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_SET_PES_FILTER for this command.
+
+ - .. row 3
+
+ - struct dmx_pes_filter_params \*params
+
+ - Pointer to structure containing filter parameters.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EBUSY``
+
+ - This error code indicates that there are conflicting requests.
+ There are active filters filtering data from another input source.
+ Make sure that these filters are stopped before starting this
+ filter.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-source.rst b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
new file mode 100644
index 000000000000..e97b1c962ed6
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_SET_SOURCE:
+
+DMX_SET_SOURCE
+==============
+
+Description
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_SET_SOURCE for this command.
+
+ - .. row 3
+
+ - dmx_source_t *
+
+ - Undocumented.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-start.rst b/Documentation/linux_tv/media/dvb/dmx-start.rst
new file mode 100644
index 000000000000..dd446da18f97
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-start.rst
@@ -0,0 +1,73 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_START:
+
+DMX_START
+=========
+
+Description
+-----------
+
+This ioctl call is used to start the actual filtering operation defined
+via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl( int fd, int request = DMX_START)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_START for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - Invalid argument, i.e. no filtering parameters provided via the
+ DMX_SET_FILTER or DMX_SET_PES_FILTER functions.
+
+ - .. row 2
+
+ - ``EBUSY``
+
+ - This error code indicates that there are conflicting requests.
+ There are active filters filtering data from another input source.
+ Make sure that these filters are stopped before starting this
+ filter.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx-stop.rst b/Documentation/linux_tv/media/dvb/dmx-stop.rst
new file mode 100644
index 000000000000..150c9f79b55f
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/dmx-stop.rst
@@ -0,0 +1,50 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _DMX_STOP:
+
+DMX_STOP
+========
+
+Description
+-----------
+
+This ioctl call is used to stop the actual filtering operation defined
+via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and
+started via the DMX_START command.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl( int fd, int request = DMX_STOP)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals DMX_STOP for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/dmx_fcalls.rst b/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
index 14335f2d2e3b..77a1554d9834 100644
--- a/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_fcalls.rst
@@ -6,1059 +6,22 @@
Demux Function Calls
********************
-
-.. _dmx_fopen:
-
-DVB demux open()
-================
-
-Description
------------
-
-This system call, used with a device name of /dev/dvb/adapter0/demux0,
-allocates a new filter and returns a handle which can be used for
-subsequent control of that filter. This call has to be made for each
-filter to be used, i.e. every returned file descriptor is a reference to
-a single filter. /dev/dvb/adapter0/dvr0 is a logical device to be used
-for retrieving Transport Streams for digital video recording. When
-reading from this device a transport stream containing the packets from
-all PES filters set in the corresponding demux device
-(/dev/dvb/adapter0/demux0) having the output set to DMX_OUT_TS_TAP. A
-recorded Transport Stream is replayed by writing to this device.
-
-The significance of blocking or non-blocking mode is described in the
-documentation for functions where there is a difference. It does not
-affect the semantics of the open() call itself. A device opened in
-blocking mode can later be put into non-blocking mode (and vice versa)
-using the F_SETFL command of the fcntl system call.
-
-Synopsis
---------
-
-.. c:function:: int open(const char *deviceName, int flags)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - const char \*deviceName
-
- - Name of demux device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDWR read/write access
-
- - .. row 4
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 5
-
- -
- - (blocking mode is the default)
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``ENODEV``
-
- - Device driver not loaded/available.
-
- - .. row 2
-
- - ``EINVAL``
-
- - Invalid argument.
-
- - .. row 3
-
- - ``EMFILE``
-
- - “Too many open files”, i.e. no more filters available.
-
- - .. row 4
-
- - ``ENOMEM``
-
- - The driver failed to allocate enough memory.
-
-
-
-.. _dmx_fclose:
-
-DVB demux close()
-=================
-
-Description
------------
-
-This system call deactivates and deallocates a filter that was
-previously allocated via the open() call.
-
-Synopsis
---------
-
-.. c:function:: int close(int fd)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
-
-
-.. _dmx_fread:
-
-DVB demux read()
-================
-
-Description
------------
-
-This system call returns filtered data, which might be section or PES
-data. The filtered data is transferred from the driver’s internal
-circular buffer to buf. The maximum amount of data to be transferred is
-implied by count.
-
-Synopsis
---------
-
-.. c:function:: size_t read(int fd, void *buf, size_t count)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - void \*buf
-
- - Pointer to the buffer to be used for returned filtered data.
-
- - .. row 3
-
- - size_t count
-
- - Size of buf.
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EWOULDBLOCK``
-
- - No data to return and O_NONBLOCK was specified.
-
- - .. row 2
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
- - .. row 3
-
- - ``ECRC``
-
- - Last section had a CRC error - no data returned. The buffer is
- flushed.
-
- - .. row 4
-
- - ``EOVERFLOW``
-
- -
-
- - .. row 5
-
- -
- - The filtered data was not read from the buffer in due time,
- resulting in non-read data being lost. The buffer is flushed.
-
- - .. row 6
-
- - ``ETIMEDOUT``
-
- - The section was not loaded within the stated timeout period. See
- ioctl DMX_SET_FILTER for how to set a timeout.
-
- - .. row 7
-
- - ``EFAULT``
-
- - The driver failed to write to the callers buffer due to an invalid
- \*buf pointer.
-
-
-
-.. _dmx_fwrite:
-
-DVB demux write()
-=================
-
-Description
------------
-
-This system call is only provided by the logical device
-/dev/dvb/adapter0/dvr0, associated with the physical demux device that
-provides the actual DVR functionality. It is used for replay of a
-digitally recorded Transport Stream. Matching filters have to be defined
-in the corresponding physical demux device, /dev/dvb/adapter0/demux0.
-The amount of data to be transferred is implied by count.
-
-Synopsis
---------
-
-.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - void \*buf
-
- - Pointer to the buffer containing the Transport Stream.
-
- - .. row 3
-
- - size_t count
-
- - Size of buf.
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EWOULDBLOCK``
-
- - No data was written. This might happen if O_NONBLOCK was
- specified and there is no more buffer space available (if
- O_NONBLOCK is not specified the function will block until buffer
- space is available).
-
- - .. row 2
-
- - ``EBUSY``
-
- - This error code indicates that there are conflicting requests. The
- corresponding demux device is setup to receive data from the
- front- end. Make sure that these filters are stopped and that the
- filters with input set to DMX_IN_DVR are started.
-
- - .. row 3
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
-
-
-.. _DMX_START:
-
-DMX_START
-=========
-
-Description
------------
-
-This ioctl call is used to start the actual filtering operation defined
-via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
-
-Synopsis
---------
-
-.. c:function:: int ioctl( int fd, int request = DMX_START)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_START for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - Invalid argument, i.e. no filtering parameters provided via the
- DMX_SET_FILTER or DMX_SET_PES_FILTER functions.
-
- - .. row 2
-
- - ``EBUSY``
-
- - This error code indicates that there are conflicting requests.
- There are active filters filtering data from another input source.
- Make sure that these filters are stopped before starting this
- filter.
-
-
-
-.. _DMX_STOP:
-
-DMX_STOP
-========
-
-Description
------------
-
-This ioctl call is used to stop the actual filtering operation defined
-via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and
-started via the DMX_START command.
-
-Synopsis
---------
-
-.. c:function:: int ioctl( int fd, int request = DMX_STOP)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_STOP for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _DMX_SET_FILTER:
-
-DMX_SET_FILTER
-==============
-
-Description
------------
-
-This ioctl call sets up a filter according to the filter and mask
-parameters provided. A timeout may be defined stating number of seconds
-to wait for a section to be loaded. A value of 0 means that no timeout
-should be applied. Finally there is a flag field where it is possible to
-state whether a section should be CRC-checked, whether the filter should
-be a ”one-shot” filter, i.e. if the filtering operation should be
-stopped after the first section is received, and whether the filtering
-operation should be started immediately (without waiting for a
-DMX_START ioctl call). If a filter was previously set-up, this filter
-will be canceled, and the receive buffer will be flushed.
-
-Synopsis
---------
-
-.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_SET_FILTER for this command.
-
- - .. row 3
-
- - struct dmx_sct_filter_params \*params
-
- - Pointer to structure containing filter parameters.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _DMX_SET_PES_FILTER:
-
-DMX_SET_PES_FILTER
-==================
-
-Description
------------
-
-This ioctl call sets up a PES filter according to the parameters
-provided. By a PES filter is meant a filter that is based just on the
-packet identifier (PID), i.e. no PES header or payload filtering
-capability is supported.
-
-Synopsis
---------
-
-.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_SET_PES_FILTER for this command.
-
- - .. row 3
-
- - struct dmx_pes_filter_params \*params
-
- - Pointer to structure containing filter parameters.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EBUSY``
-
- - This error code indicates that there are conflicting requests.
- There are active filters filtering data from another input source.
- Make sure that these filters are stopped before starting this
- filter.
-
-
-
-.. _DMX_SET_BUFFER_SIZE:
-
-DMX_SET_BUFFER_SIZE
-===================
-
-Description
------------
-
-This ioctl call is used to set the size of the circular buffer used for
-filtered data. The default size is two maximum sized sections, i.e. if
-this function is not called a buffer size of 2 \* 4096 bytes will be
-used.
-
-Synopsis
---------
-
-.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_SET_BUFFER_SIZE for this command.
-
- - .. row 3
-
- - unsigned long size
-
- - Size of circular buffer.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _DMX_GET_EVENT:
-
-DMX_GET_EVENT
-=============
-
-Description
------------
-
-This ioctl call returns an event if available. If an event is not
-available, the behavior depends on whether the device is in blocking or
-non-blocking mode. In the latter case, the call fails immediately with
-errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
-event becomes available.
-
-Synopsis
---------
-
-.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_GET_EVENT for this command.
-
- - .. row 3
-
- - struct dmx_event \*ev
-
- - Pointer to the location where the event is to be stored.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EWOULDBLOCK``
-
- - There is no event pending, and the device is in non-blocking mode.
-
-
-
-.. _DMX_GET_STC:
-
-DMX_GET_STC
-===========
-
-Description
------------
-
-This ioctl call returns the current value of the system time counter
-(which is driven by a PES filter of type DMX_PES_PCR). Some hardware
-supports more than one STC, so you must specify which one by setting the
-num field of stc before the ioctl (range 0...n). The result is returned
-in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
-the real 90kHz STC value is stc->stc / stc->base .
-
-Synopsis
---------
-
-.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_GET_STC for this command.
-
- - .. row 3
-
- - struct dmx_stc \*stc
-
- - Pointer to the location where the stc is to be stored.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - Invalid stc number.
-
-
-
-.. _DMX_GET_PES_PIDS:
-
-DMX_GET_PES_PIDS
-================
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_GET_PES_PIDS for this command.
-
- - .. row 3
-
- - __u16[5]
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _DMX_GET_CAPS:
-
-DMX_GET_CAPS
-============
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_GET_CAPS for this command.
-
- - .. row 3
-
- - dmx_caps_t *
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _DMX_SET_SOURCE:
-
-DMX_SET_SOURCE
-==============
-
-Description
------------
-
-This ioctl is undocumented. Documentation is welcome.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_SET_SOURCE for this command.
-
- - .. row 3
-
- - dmx_source_t *
-
- - Undocumented.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _DMX_ADD_PID:
-
-DMX_ADD_PID
-===========
-
-Description
------------
-
-This ioctl call allows to add multiple PIDs to a transport stream filter
-previously set up with DMX_SET_PES_FILTER and output equal to
-DMX_OUT_TSDEMUX_TAP.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_ADD_PID for this command.
-
- - .. row 3
-
- - __u16 *
-
- - PID number to be filtered.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _DMX_REMOVE_PID:
-
-DMX_REMOVE_PID
-==============
-
-Description
------------
-
-This ioctl call allows to remove a PID when multiple PIDs are set on a
-transport stream filter, e. g. a filter previously set up with output
-equal to DMX_OUT_TSDEMUX_TAP, created via either
-DMX_SET_PES_FILTER or DMX_ADD_PID.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals DMX_REMOVE_PID for this command.
-
- - .. row 3
-
- - __u16 *
-
- - PID of the PES filter to be removed.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+.. toctree::
+ :maxdepth: 1
+
+ dmx-fopen
+ dmx-fclose
+ dmx-fread
+ dmx-fwrite
+ dmx-start
+ dmx-stop
+ dmx-set-filter
+ dmx-set-pes-filter
+ dmx-set-buffer-size
+ dmx-get-event
+ dmx-get-stc
+ dmx-get-pes-pids
+ dmx-get-caps
+ dmx-set-source
+ dmx-add-pid
+ dmx-remove-pid
diff --git a/Documentation/linux_tv/media/dvb/net-add-if.rst b/Documentation/linux_tv/media/dvb/net-add-if.rst
new file mode 100644
index 000000000000..da0e7870c5d9
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/net-add-if.rst
@@ -0,0 +1,87 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _NET_ADD_IF:
+
+****************
+ioctl NET_ADD_IF
+****************
+
+*man NET_ADD_IF(2)*
+
+Creates a new network interface for a given Packet ID.
+
+
+Synopsis
+========
+
+.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
+
+Arguments
+=========
+
+``fd``
+ File descriptor returned by :ref:`open() <frontend_f_open>`.
+
+``request``
+ FE_SET_TONE
+
+``net_if``
+ pointer to struct :ref:`dvb_net_if <dvb-net-if>`
+
+
+Description
+===========
+
+The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
+contains a TCP/IP traffic, the type of encapsulation to be used (MPE or
+ULE) and the interface number for the new interface to be created. When
+the system call successfully returns, a new virtual network interface is
+created.
+
+The struct :ref:`dvb_net_if <dvb-net-if>`::ifnum field will be
+filled with the number of the created interface.
+
+
+.. _dvb-net-if-t:
+
+struct dvb_net_if description
+=============================
+
+.. _dvb-net-if:
+
+.. flat-table:: struct dvb_net_if
+ :header-rows: 1
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ID
+
+ - Description
+
+ - .. row 2
+
+ - pid
+
+ - Packet ID (PID) of the MPEG-TS that contains data
+
+ - .. row 3
+
+ - ifnum
+
+ - number of the DVB interface.
+
+ - .. row 4
+
+ - feedtype
+
+ - Encapsulation type of the feed. It can be:
+ ``DVB_NET_FEEDTYPE_MPE`` for MPE encoding or
+ ``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
+
+RETURN VALUE
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/net-get-if.rst b/Documentation/linux_tv/media/dvb/net-get-if.rst
new file mode 100644
index 000000000000..4581763b920e
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/net-get-if.rst
@@ -0,0 +1,48 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+
+.. _NET_GET_IF:
+
+****************
+ioctl NET_GET_IF
+****************
+
+*man NET_GET_IF(2)*
+
+Read the configuration data of an interface created via
+:ref:`NET_ADD_IF <net>`.
+
+
+Synopsis
+========
+
+.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
+
+Arguments
+=========
+
+``fd``
+ File descriptor returned by :ref:`open() <frontend_f_open>`.
+
+``request``
+ FE_SET_TONE
+
+``net_if``
+ pointer to struct :ref:`dvb_net_if <dvb-net-if>`
+
+
+Description
+===========
+
+The NET_GET_IF ioctl uses the interface number given by the struct
+:ref:`dvb_net_if <dvb-net-if>`::ifnum field and fills the content of
+struct :ref:`dvb_net_if <dvb-net-if>` with the packet ID and
+encapsulation type used on such interface. If the interface was not
+created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
+the ``errno`` with ``EINVAL`` error code.
+
+RETURN VALUE
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/net-remove-if.rst b/Documentation/linux_tv/media/dvb/net-remove-if.rst
new file mode 100644
index 000000000000..15a5d49f7a80
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/net-remove-if.rst
@@ -0,0 +1,42 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _NET_REMOVE_IF:
+
+*******************
+ioctl NET_REMOVE_IF
+*******************
+
+*man NET_REMOVE_IF(2)*
+
+Removes a network interface.
+
+
+Synopsis
+========
+
+.. cpp:function:: int ioctl( int fd, int request, int ifnum )
+
+Arguments
+=========
+
+``fd``
+ File descriptor returned by :ref:`open() <frontend_f_open>`.
+
+``request``
+ FE_SET_TONE
+
+``net_if``
+ number of the interface to be removed
+
+
+Description
+===========
+
+The NET_REMOVE_IF ioctl deletes an interface previously created via
+:ref:`NET_ADD_IF <net>`.
+
+RETURN VALUE
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/net.rst b/Documentation/linux_tv/media/dvb/net.rst
index c5c42e43d277..eca42dd53261 100644
--- a/Documentation/linux_tv/media/dvb/net.rst
+++ b/Documentation/linux_tv/media/dvb/net.rst
@@ -32,179 +32,9 @@ header.
DVB net Function Calls
######################
-.. _NET_ADD_IF:
+.. toctree::
+ :maxdepth: 1
-****************
-ioctl NET_ADD_IF
-****************
-
-*man NET_ADD_IF(2)*
-
-Creates a new network interface for a given Packet ID.
-
-
-Synopsis
-========
-
-.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-
-Arguments
-=========
-
-``fd``
- File descriptor returned by :ref:`open() <frontend_f_open>`.
-
-``request``
- FE_SET_TONE
-
-``net_if``
- pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-
-
-Description
-===========
-
-The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
-contains a TCP/IP traffic, the type of encapsulation to be used (MPE or
-ULE) and the interface number for the new interface to be created. When
-the system call successfully returns, a new virtual network interface is
-created.
-
-The struct :ref:`dvb_net_if <dvb-net-if>`::ifnum field will be
-filled with the number of the created interface.
-
-RETURN VALUE
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _dvb-net-if-t:
-
-struct dvb_net_if description
-=============================
-
-
-.. _dvb-net-if:
-
-.. flat-table:: struct dvb_net_if
- :header-rows: 1
- :stub-columns: 0
-
-
- - .. row 1
-
- - ID
-
- - Description
-
- - .. row 2
-
- - pid
-
- - Packet ID (PID) of the MPEG-TS that contains data
-
- - .. row 3
-
- - ifnum
-
- - number of the DVB interface.
-
- - .. row 4
-
- - feedtype
-
- - Encapsulation type of the feed. It can be:
- ``DVB_NET_FEEDTYPE_MPE`` for MPE encoding or
- ``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
-
-
-
-.. _NET_REMOVE_IF:
-
-*******************
-ioctl NET_REMOVE_IF
-*******************
-
-*man NET_REMOVE_IF(2)*
-
-Removes a network interface.
-
-
-Synopsis
-========
-
-.. cpp:function:: int ioctl( int fd, int request, int ifnum )
-
-Arguments
-=========
-
-``fd``
- File descriptor returned by :ref:`open() <frontend_f_open>`.
-
-``request``
- FE_SET_TONE
-
-``net_if``
- number of the interface to be removed
-
-
-Description
-===========
-
-The NET_REMOVE_IF ioctl deletes an interface previously created via
-:ref:`NET_ADD_IF <net>`.
-
-RETURN VALUE
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _NET_GET_IF:
-
-****************
-ioctl NET_GET_IF
-****************
-
-*man NET_GET_IF(2)*
-
-Read the configuration data of an interface created via
-:ref:`NET_ADD_IF <net>`.
-
-
-Synopsis
-========
-
-.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-
-Arguments
-=========
-
-``fd``
- File descriptor returned by :ref:`open() <frontend_f_open>`.
-
-``request``
- FE_SET_TONE
-
-``net_if``
- pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-
-
-Description
-===========
-
-The NET_GET_IF ioctl uses the interface number given by the struct
-:ref:`dvb_net_if <dvb-net-if>`::ifnum field and fills the content of
-struct :ref:`dvb_net_if <dvb-net-if>` with the packet ID and
-encapsulation type used on such interface. If the interface was not
-created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
-the ``errno`` with ``EINVAL`` error code.
-
-RETURN VALUE
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
+ net-add-if
+ net-remove-if
+ net-get-if
diff --git a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
new file mode 100644
index 000000000000..65efef3cc0fc
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
@@ -0,0 +1,49 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_CLEAR_BUFFER:
+
+VIDEO_CLEAR_BUFFER
+==================
+
+Description
+-----------
+
+This ioctl call clears all video buffers in the driver and in the
+decoder hardware.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_CLEAR_BUFFER for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-command.rst b/Documentation/linux_tv/media/dvb/video-command.rst
new file mode 100644
index 000000000000..855a646a0f93
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-command.rst
@@ -0,0 +1,61 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_COMMAND:
+
+VIDEO_COMMAND
+=============
+
+Description
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the
+:ref:`VIDIOC_DECODER_CMD` ioctl.
+
+This ioctl commands the decoder. The ``video_command`` struct is a
+subset of the ``v4l2_decoder_cmd`` struct, so refer to the
+:ref:`VIDIOC_DECODER_CMD` documentation for
+more information.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_COMMAND for this command.
+
+ - .. row 3
+
+ - struct video_command \*cmd
+
+ - Commands the decoder.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-continue.rst b/Documentation/linux_tv/media/dvb/video-continue.rst
new file mode 100644
index 000000000000..9d0f70b7c340
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-continue.rst
@@ -0,0 +1,52 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_CONTINUE:
+
+VIDEO_CONTINUE
+==============
+
+Description
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call restarts decoding and playing processes of the video
+stream which was played before a call to VIDEO_FREEZE was made.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_CONTINUE for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-fast-forward.rst b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
new file mode 100644
index 000000000000..3cf7d2d9d817
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
@@ -0,0 +1,70 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_FAST_FORWARD:
+
+VIDEO_FAST_FORWARD
+==================
+
+Description
+-----------
+
+This ioctl call asks the Video Device to skip decoding of N number of
+I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
+selected.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_FAST_FORWARD for this command.
+
+ - .. row 3
+
+ - int nFrames
+
+ - The number of frames to skip.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EPERM``
+
+ - Mode VIDEO_SOURCE_MEMORY not selected.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-fclose.rst b/Documentation/linux_tv/media/dvb/video-fclose.rst
new file mode 100644
index 000000000000..c9fc6560cb43
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-fclose.rst
@@ -0,0 +1,52 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _video_fclose:
+
+dvb video close()
+=================
+
+Description
+-----------
+
+This system call closes a previously opened video device.
+
+Synopsis
+--------
+
+.. c:function:: int close(int fd)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-fopen.rst b/Documentation/linux_tv/media/dvb/video-fopen.rst
new file mode 100644
index 000000000000..9de94d4f69dd
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-fopen.rst
@@ -0,0 +1,108 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _video_fopen:
+
+dvb video open()
+================
+
+Description
+-----------
+
+This system call opens a named video device (e.g.
+/dev/dvb/adapter0/video0) for subsequent use.
+
+When an open() call has succeeded, the device will be ready for use. The
+significance of blocking or non-blocking mode is described in the
+documentation for functions where there is a difference. It does not
+affect the semantics of the open() call itself. A device opened in
+blocking mode can later be put into non-blocking mode (and vice versa)
+using the F_SETFL command of the fcntl system call. This is a standard
+system call, documented in the Linux manual page for fcntl. Only one
+user can open the Video Device in O_RDWR mode. All other attempts to
+open the device in this mode will fail, and an error-code will be
+returned. If the Video Device is opened in O_RDONLY mode, the only
+ioctl call that can be used is VIDEO_GET_STATUS. All other call will
+return an error code.
+
+Synopsis
+--------
+
+.. c:function:: int open(const char *deviceName, int flags)
+
+Arguments
+----------
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - const char \*deviceName
+
+ - Name of specific video device.
+
+ - .. row 2
+
+ - int flags
+
+ - A bit-wise OR of the following flags:
+
+ - .. row 3
+
+ -
+ - O_RDONLY read-only access
+
+ - .. row 4
+
+ -
+ - O_RDWR read/write access
+
+ - .. row 5
+
+ -
+ - O_NONBLOCK open in non-blocking mode
+
+ - .. row 6
+
+ -
+ - (blocking mode is the default)
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``ENODEV``
+
+ - Device driver not loaded/available.
+
+ - .. row 2
+
+ - ``EINTERNAL``
+
+ - Internal error.
+
+ - .. row 3
+
+ - ``EBUSY``
+
+ - Device or resource busy.
+
+ - .. row 4
+
+ - ``EINVAL``
+
+ - Invalid argument.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-freeze.rst b/Documentation/linux_tv/media/dvb/video-freeze.rst
new file mode 100644
index 000000000000..d384e329b661
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-freeze.rst
@@ -0,0 +1,56 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_FREEZE:
+
+VIDEO_FREEZE
+============
+
+Description
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call suspends the live video stream being played. Decoding
+and playing are frozen. It is then possible to restart the decoding and
+playing process of the video stream using the VIDEO_CONTINUE command.
+If VIDEO_SOURCE_MEMORY is selected in the ioctl call
+VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
+until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_FREEZE for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-fwrite.rst b/Documentation/linux_tv/media/dvb/video-fwrite.rst
new file mode 100644
index 000000000000..398bbeaeaf8b
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-fwrite.rst
@@ -0,0 +1,80 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _video_fwrite:
+
+dvb video write()
+=================
+
+Description
+-----------
+
+This system call can only be used if VIDEO_SOURCE_MEMORY is selected
+in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in
+PES format, unless the capability allows other formats. If O_NONBLOCK
+is not specified the function will block until buffer space is
+available. The amount of data to be transferred is implied by count.
+
+Synopsis
+--------
+
+.. c:function:: size_t write(int fd, const void *buf, size_t count)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - void \*buf
+
+ - Pointer to the buffer containing the PES data.
+
+ - .. row 3
+
+ - size_t count
+
+ - Size of buf.
+
+
+Return Value
+------------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EPERM``
+
+ - Mode VIDEO_SOURCE_MEMORY not selected.
+
+ - .. row 2
+
+ - ``ENOMEM``
+
+ - Attempted to write more data than the internal buffer can hold.
+
+ - .. row 3
+
+ - ``EBADF``
+
+ - fd is not a valid open file descriptor.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
new file mode 100644
index 000000000000..7b5dcc523a69
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
@@ -0,0 +1,56 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_CAPABILITIES:
+
+VIDEO_GET_CAPABILITIES
+======================
+
+Description
+-----------
+
+This ioctl call asks the video device about its decoding capabilities.
+On success it returns and integer which has bits set according to the
+defines in section ??.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_CAPABILITIES for this command.
+
+ - .. row 3
+
+ - unsigned int \*cap
+
+ - Pointer to a location where to store the capability information.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-event.rst b/Documentation/linux_tv/media/dvb/video-get-event.rst
new file mode 100644
index 000000000000..b958652cac7b
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-event.rst
@@ -0,0 +1,86 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_EVENT:
+
+VIDEO_GET_EVENT
+===============
+
+Description
+-----------
+
+This ioctl is for DVB devices only. To get events from a V4L2 decoder
+use the V4L2 :ref:`VIDIOC_DQEVENT` ioctl instead.
+
+This ioctl call returns an event of type video_event if available. If
+an event is not available, the behavior depends on whether the device is
+in blocking or non-blocking mode. In the latter case, the call fails
+immediately with errno set to ``EWOULDBLOCK``. In the former case, the call
+blocks until an event becomes available. The standard Linux poll()
+and/or select() system calls can be used with the device file descriptor
+to watch for new events. For select(), the file descriptor should be
+included in the exceptfds argument, and for poll(), POLLPRI should be
+specified as the wake-up condition. Read-only permissions are sufficient
+for this ioctl call.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_EVENT for this command.
+
+ - .. row 3
+
+ - struct video_event \*ev
+
+ - Points to the location where the event, if any, is to be stored.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EWOULDBLOCK``
+
+ - There is no event pending, and the device is in non-blocking mode.
+
+ - .. row 2
+
+ - ``EOVERFLOW``
+
+ - Overflow in event queue - one or more events were lost.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
new file mode 100644
index 000000000000..c7c140f2467a
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
@@ -0,0 +1,60 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_FRAME_COUNT:
+
+VIDEO_GET_FRAME_COUNT
+=====================
+
+Description
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_FRAME``
+control.
+
+This ioctl call asks the Video Device to return the number of displayed
+frames since the decoder was started.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_FRAME_COUNT for this command.
+
+ - .. row 3
+
+ - __u64 \*pts
+
+ - Returns the number of frames displayed since the decoder was
+ started.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
new file mode 100644
index 000000000000..bfd09385cb31
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_FRAME_RATE:
+
+VIDEO_GET_FRAME_RATE
+====================
+
+Description
+-----------
+
+This ioctl call asks the Video Device to return the current framerate.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_FRAME_RATE for this command.
+
+ - .. row 3
+
+ - unsigned int \*rate
+
+ - Returns the framerate in number of frames per 1000 seconds.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-navi.rst b/Documentation/linux_tv/media/dvb/video-get-navi.rst
new file mode 100644
index 000000000000..62451fc03924
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-navi.rst
@@ -0,0 +1,70 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_NAVI:
+
+VIDEO_GET_NAVI
+==============
+
+Description
+-----------
+
+This ioctl returns navigational information from the DVD stream. This is
+especially needed if an encoded stream has to be decoded by the
+hardware.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_NAVI for this command.
+
+ - .. row 3
+
+ - video_navi_pack_t \*navipack
+
+ - PCI or DSI pack (private stream 2) according to section ??.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EFAULT``
+
+ - driver is not able to return navigational information
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-pts.rst b/Documentation/linux_tv/media/dvb/video-get-pts.rst
new file mode 100644
index 000000000000..67b929753963
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-pts.rst
@@ -0,0 +1,64 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_PTS:
+
+VIDEO_GET_PTS
+=============
+
+Description
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS``
+control.
+
+This ioctl call asks the Video Device to return the current PTS
+timestamp.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_PTS for this command.
+
+ - .. row 3
+
+ - __u64 \*pts
+
+ - Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
+ ISO/IEC 13818-1.
+
+ The PTS should belong to the currently played frame if possible,
+ but may also be a value close to it like the PTS of the last
+ decoded frame or the last PTS extracted by the PES parser.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-size.rst b/Documentation/linux_tv/media/dvb/video-get-size.rst
new file mode 100644
index 000000000000..0e16d91838ac
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-size.rst
@@ -0,0 +1,54 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_SIZE:
+
+VIDEO_GET_SIZE
+==============
+
+Description
+-----------
+
+This ioctl returns the size and aspect ratio.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_SIZE for this command.
+
+ - .. row 3
+
+ - video_size_t \*size
+
+ - Returns the size and aspect ratio.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-get-status.rst b/Documentation/linux_tv/media/dvb/video-get-status.rst
new file mode 100644
index 000000000000..fd9e591de5df
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-get-status.rst
@@ -0,0 +1,55 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_GET_STATUS:
+
+VIDEO_GET_STATUS
+================
+
+Description
+-----------
+
+This ioctl call asks the Video Device to return the current status of
+the device.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_STATUS for this command.
+
+ - .. row 3
+
+ - struct video_status \*status
+
+ - Returns the current status of the Video Device.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-play.rst b/Documentation/linux_tv/media/dvb/video-play.rst
new file mode 100644
index 000000000000..da328ed2b4a0
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-play.rst
@@ -0,0 +1,52 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_PLAY:
+
+VIDEO_PLAY
+==========
+
+Description
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call asks the Video Device to start playing a video stream
+from the selected source.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_PLAY for this command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-select-source.rst b/Documentation/linux_tv/media/dvb/video-select-source.rst
new file mode 100644
index 000000000000..41fc728508c0
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-select-source.rst
@@ -0,0 +1,60 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SELECT_SOURCE:
+
+VIDEO_SELECT_SOURCE
+===================
+
+Description
+-----------
+
+This ioctl is for DVB devices only. This ioctl was also supported by the
+V4L2 ivtv driver, but that has been replaced by the ivtv-specific
+``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
+
+This ioctl call informs the video device which source shall be used for
+the input data. The possible sources are demux or memory. If memory is
+selected, the data is fed to the video device through the write command.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SELECT_SOURCE for this command.
+
+ - .. row 3
+
+ - video_stream_source_t source
+
+ - Indicates which source shall be used for the Video stream.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-attributes.rst b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
new file mode 100644
index 000000000000..255efe0872d1
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
@@ -0,0 +1,68 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_ATTRIBUTES:
+
+VIDEO_SET_ATTRIBUTES
+====================
+
+Description
+-----------
+
+This ioctl is intended for DVD playback and allows you to set certain
+information about the stream. Some hardware may not need this
+information, but the call also tells the hardware to prepare for DVD
+playback.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_ATTRIBUTE for this command.
+
+ - .. row 3
+
+ - video_attributes_t vattr
+
+ - video attributes according to section ??.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - input is not a valid attribute setting.
diff --git a/Documentation/linux_tv/media/dvb/video-set-blank.rst b/Documentation/linux_tv/media/dvb/video-set-blank.rst
new file mode 100644
index 000000000000..0ed2afdf4b72
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-blank.rst
@@ -0,0 +1,59 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_BLANK:
+
+VIDEO_SET_BLANK
+===============
+
+Description
+-----------
+
+This ioctl call asks the Video Device to blank out the picture.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_BLANK for this command.
+
+ - .. row 3
+
+ - boolean mode
+
+ - TRUE: Blank screen when stop.
+
+ - .. row 4
+
+ -
+ - FALSE: Show last decoded frame.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-display-format.rst b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
new file mode 100644
index 000000000000..af55cefbd3c0
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
@@ -0,0 +1,55 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_DISPLAY_FORMAT:
+
+VIDEO_SET_DISPLAY_FORMAT
+========================
+
+Description
+-----------
+
+This ioctl call asks the Video Device to select the video format to be
+applied by the MPEG chip on the video.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_DISPLAY_FORMAT for this command.
+
+ - .. row 3
+
+ - video_display_format_t format
+
+ - Selects the video format to be used.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-format.rst b/Documentation/linux_tv/media/dvb/video-set-format.rst
new file mode 100644
index 000000000000..aea4d913c760
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-format.rst
@@ -0,0 +1,70 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_FORMAT:
+
+VIDEO_SET_FORMAT
+================
+
+Description
+-----------
+
+This ioctl sets the screen format (aspect ratio) of the connected output
+device (TV) so that the output of the decoder can be adjusted
+accordingly.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_FORMAT for this command.
+
+ - .. row 3
+
+ - video_format_t format
+
+ - video format of TV as defined in section ??.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - format is not a valid video format.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-highlight.rst b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
new file mode 100644
index 000000000000..e92b7ac28f23
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
@@ -0,0 +1,55 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_HIGHLIGHT:
+
+VIDEO_SET_HIGHLIGHT
+===================
+
+Description
+-----------
+
+This ioctl sets the SPU highlight information for the menu access of a
+DVD.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_HIGHLIGHT for this command.
+
+ - .. row 3
+
+ - video_highlight_t \*vhilite
+
+ - SPU Highlight information according to section ??.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-id.rst b/Documentation/linux_tv/media/dvb/video-set-id.rst
new file mode 100644
index 000000000000..5a58405fba42
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-id.rst
@@ -0,0 +1,69 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_ID:
+
+VIDEO_SET_ID
+============
+
+Description
+-----------
+
+This ioctl selects which sub-stream is to be decoded if a program or
+system stream is sent to the video device.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_ID for this command.
+
+ - .. row 3
+
+ - int id
+
+ - video sub-stream id
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - Invalid sub-stream id.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
new file mode 100644
index 000000000000..3fb338ee7420
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
@@ -0,0 +1,68 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_SPU_PALETTE:
+
+VIDEO_SET_SPU_PALETTE
+=====================
+
+Description
+-----------
+
+This ioctl sets the SPU color palette.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_SPU_PALETTE for this command.
+
+ - .. row 3
+
+ - video_spu_palette_t \*palette
+
+ - SPU palette according to section ??.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - input is not a valid palette or driver doesn’t handle SPU.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu.rst b/Documentation/linux_tv/media/dvb/video-set-spu.rst
new file mode 100644
index 000000000000..863c6248fab9
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-spu.rst
@@ -0,0 +1,70 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_SPU:
+
+VIDEO_SET_SPU
+=============
+
+Description
+-----------
+
+This ioctl activates or deactivates SPU decoding in a DVD input stream.
+It can only be used, if the driver is able to handle a DVD stream.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_SPU for this command.
+
+ - .. row 3
+
+ - video_spu_t \*spu
+
+ - SPU decoding (de)activation and subid setting according to section
+ ??.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - input is not a valid spu setting or driver cannot handle SPU.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
new file mode 100644
index 000000000000..c412051cc073
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
@@ -0,0 +1,56 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_STREAMTYPE:
+
+VIDEO_SET_STREAMTYPE
+====================
+
+Description
+-----------
+
+This ioctl tells the driver which kind of stream to expect being written
+to it. If this call is not used the default of video PES is used. Some
+drivers might not support this call and always expect PES.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_STREAMTYPE for this command.
+
+ - .. row 3
+
+ - int type
+
+ - stream type
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-set-system.rst b/Documentation/linux_tv/media/dvb/video-set-system.rst
new file mode 100644
index 000000000000..70bff8a1c53a
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-set-system.rst
@@ -0,0 +1,71 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SET_SYSTEM:
+
+VIDEO_SET_SYSTEM
+================
+
+Description
+-----------
+
+This ioctl sets the television output format. The format (see section
+??) may vary from the color format of the displayed MPEG stream. If the
+hardware is not able to display the requested format the call will
+return an error.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SET_FORMAT for this command.
+
+ - .. row 3
+
+ - video_system_t system
+
+ - video system of TV output.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EINVAL``
+
+ - system is not a valid or supported video system.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-slowmotion.rst b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
new file mode 100644
index 000000000000..e04ad5776683
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
@@ -0,0 +1,70 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_SLOWMOTION:
+
+VIDEO_SLOWMOTION
+================
+
+Description
+-----------
+
+This ioctl call asks the video device to repeat decoding frames N number
+of times. This call can only be used if VIDEO_SOURCE_MEMORY is
+selected.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_SLOWMOTION for this command.
+
+ - .. row 3
+
+ - int nFrames
+
+ - The number of times to repeat each frame.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - ``EPERM``
+
+ - Mode VIDEO_SOURCE_MEMORY not selected.
+
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-stillpicture.rst b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
new file mode 100644
index 000000000000..94ae66c1d97b
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
@@ -0,0 +1,56 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_STILLPICTURE:
+
+VIDEO_STILLPICTURE
+==================
+
+Description
+-----------
+
+This ioctl call asks the Video Device to display a still picture
+(I-frame). The input data shall contain an I-frame. If the pointer is
+NULL, then the current displayed still picture is blanked.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_STILLPICTURE for this command.
+
+ - .. row 3
+
+ - struct video_still_picture \*sp
+
+ - Pointer to a location where an I-frame and size is stored.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-stop.rst b/Documentation/linux_tv/media/dvb/video-stop.rst
new file mode 100644
index 000000000000..fd5288727911
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-stop.rst
@@ -0,0 +1,69 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_STOP:
+
+VIDEO_STOP
+==========
+
+Description
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call asks the Video Device to stop playing the current
+stream. Depending on the input parameter, the screen can be blanked out
+or displaying the last decoded frame.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_STOP for this command.
+
+ - .. row 3
+
+ - Boolean mode
+
+ - Indicates how the screen shall be handled.
+
+ - .. row 4
+
+ -
+ - TRUE: Blank screen when stop.
+
+ - .. row 5
+
+ -
+ - FALSE: Show last decoded frame.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video-try-command.rst b/Documentation/linux_tv/media/dvb/video-try-command.rst
new file mode 100644
index 000000000000..57eff3daf7bd
--- /dev/null
+++ b/Documentation/linux_tv/media/dvb/video-try-command.rst
@@ -0,0 +1,61 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _VIDEO_TRY_COMMAND:
+
+VIDEO_TRY_COMMAND
+=================
+
+Description
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the
+:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
+
+This ioctl tries a decoder command. The ``video_command`` struct is a
+subset of the ``v4l2_decoder_cmd`` struct, so refer to the
+:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
+for more information.
+
+Synopsis
+--------
+
+.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
+
+Arguments
+----------
+
+
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_TRY_COMMAND for this command.
+
+ - .. row 3
+
+ - struct video_command \*cmd
+
+ - Try a decoder command.
+
+
+Return Value
+------------
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
+
diff --git a/Documentation/linux_tv/media/dvb/video_function_calls.rst b/Documentation/linux_tv/media/dvb/video_function_calls.rst
index a337fbf51bc0..68588ac7fecb 100644
--- a/Documentation/linux_tv/media/dvb/video_function_calls.rst
+++ b/Documentation/linux_tv/media/dvb/video_function_calls.rst
@@ -6,1976 +6,38 @@
Video Function Calls
********************
-
-.. _video_fopen:
-
-dvb video open()
-================
-
-Description
------------
-
-This system call opens a named video device (e.g.
-/dev/dvb/adapter0/video0) for subsequent use.
-
-When an open() call has succeeded, the device will be ready for use. The
-significance of blocking or non-blocking mode is described in the
-documentation for functions where there is a difference. It does not
-affect the semantics of the open() call itself. A device opened in
-blocking mode can later be put into non-blocking mode (and vice versa)
-using the F_SETFL command of the fcntl system call. This is a standard
-system call, documented in the Linux manual page for fcntl. Only one
-user can open the Video Device in O_RDWR mode. All other attempts to
-open the device in this mode will fail, and an error-code will be
-returned. If the Video Device is opened in O_RDONLY mode, the only
-ioctl call that can be used is VIDEO_GET_STATUS. All other call will
-return an error code.
-
-Synopsis
---------
-
-.. c:function:: int open(const char *deviceName, int flags)
-
-Arguments
-----------
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - const char \*deviceName
-
- - Name of specific video device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDONLY read-only access
-
- - .. row 4
-
- -
- - O_RDWR read/write access
-
- - .. row 5
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 6
-
- -
- - (blocking mode is the default)
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``ENODEV``
-
- - Device driver not loaded/available.
-
- - .. row 2
-
- - ``EINTERNAL``
-
- - Internal error.
-
- - .. row 3
-
- - ``EBUSY``
-
- - Device or resource busy.
-
- - .. row 4
-
- - ``EINVAL``
-
- - Invalid argument.
-
-
-
-.. _video_fclose:
-
-dvb video close()
-=================
-
-Description
------------
-
-This system call closes a previously opened video device.
-
-Synopsis
---------
-
-.. c:function:: int close(int fd)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
-
-
-.. _video_fwrite:
-
-dvb video write()
-=================
-
-Description
------------
-
-This system call can only be used if VIDEO_SOURCE_MEMORY is selected
-in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in
-PES format, unless the capability allows other formats. If O_NONBLOCK
-is not specified the function will block until buffer space is
-available. The amount of data to be transferred is implied by count.
-
-Synopsis
---------
-
-.. c:function:: size_t write(int fd, const void *buf, size_t count)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - void \*buf
-
- - Pointer to the buffer containing the PES data.
-
- - .. row 3
-
- - size_t count
-
- - Size of buf.
-
-
-Return Value
-------------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EPERM``
-
- - Mode VIDEO_SOURCE_MEMORY not selected.
-
- - .. row 2
-
- - ``ENOMEM``
-
- - Attempted to write more data than the internal buffer can hold.
-
- - .. row 3
-
- - ``EBADF``
-
- - fd is not a valid open file descriptor.
-
-
-
-.. _VIDEO_STOP:
-
-VIDEO_STOP
-==========
-
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
-
-This ioctl call asks the Video Device to stop playing the current
-stream. Depending on the input parameter, the screen can be blanked out
-or displaying the last decoded frame.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_STOP for this command.
-
- - .. row 3
-
- - Boolean mode
-
- - Indicates how the screen shall be handled.
-
- - .. row 4
-
- -
- - TRUE: Blank screen when stop.
-
- - .. row 5
-
- -
- - FALSE: Show last decoded frame.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_PLAY:
-
-VIDEO_PLAY
-==========
-
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
-
-This ioctl call asks the Video Device to start playing a video stream
-from the selected source.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_PLAY for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_FREEZE:
-
-VIDEO_FREEZE
-============
-
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
-
-This ioctl call suspends the live video stream being played. Decoding
-and playing are frozen. It is then possible to restart the decoding and
-playing process of the video stream using the VIDEO_CONTINUE command.
-If VIDEO_SOURCE_MEMORY is selected in the ioctl call
-VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
-until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_FREEZE for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_CONTINUE:
-
-VIDEO_CONTINUE
-==============
-
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
-
-This ioctl call restarts decoding and playing processes of the video
-stream which was played before a call to VIDEO_FREEZE was made.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_CONTINUE for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_SELECT_SOURCE:
-
-VIDEO_SELECT_SOURCE
-===================
-
-Description
------------
-
-This ioctl is for DVB devices only. This ioctl was also supported by the
-V4L2 ivtv driver, but that has been replaced by the ivtv-specific
-``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
-
-This ioctl call informs the video device which source shall be used for
-the input data. The possible sources are demux or memory. If memory is
-selected, the data is fed to the video device through the write command.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SELECT_SOURCE for this command.
-
- - .. row 3
-
- - video_stream_source_t source
-
- - Indicates which source shall be used for the Video stream.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_SET_BLANK:
-
-VIDEO_SET_BLANK
-===============
-
-Description
------------
-
-This ioctl call asks the Video Device to blank out the picture.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_BLANK for this command.
-
- - .. row 3
-
- - boolean mode
-
- - TRUE: Blank screen when stop.
-
- - .. row 4
-
- -
- - FALSE: Show last decoded frame.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_GET_STATUS:
-
-VIDEO_GET_STATUS
-================
-
-Description
------------
-
-This ioctl call asks the Video Device to return the current status of
-the device.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_STATUS for this command.
-
- - .. row 3
-
- - struct video_status \*status
-
- - Returns the current status of the Video Device.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_GET_FRAME_COUNT:
-
-VIDEO_GET_FRAME_COUNT
-=====================
-
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_FRAME``
-control.
-
-This ioctl call asks the Video Device to return the number of displayed
-frames since the decoder was started.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_FRAME_COUNT for this command.
-
- - .. row 3
-
- - __u64 \*pts
-
- - Returns the number of frames displayed since the decoder was
- started.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_GET_PTS:
-
-VIDEO_GET_PTS
-=============
-
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS``
-control.
-
-This ioctl call asks the Video Device to return the current PTS
-timestamp.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_PTS for this command.
-
- - .. row 3
-
- - __u64 \*pts
-
- - Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 /
- ISO/IEC 13818-1.
-
- The PTS should belong to the currently played frame if possible,
- but may also be a value close to it like the PTS of the last
- decoded frame or the last PTS extracted by the PES parser.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_GET_FRAME_RATE:
-
-VIDEO_GET_FRAME_RATE
-====================
-
-Description
------------
-
-This ioctl call asks the Video Device to return the current framerate.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_FRAME_RATE for this command.
-
- - .. row 3
-
- - unsigned int \*rate
-
- - Returns the framerate in number of frames per 1000 seconds.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_GET_EVENT:
-
-VIDEO_GET_EVENT
-===============
-
-Description
------------
-
-This ioctl is for DVB devices only. To get events from a V4L2 decoder
-use the V4L2 :ref:`VIDIOC_DQEVENT` ioctl instead.
-
-This ioctl call returns an event of type video_event if available. If
-an event is not available, the behavior depends on whether the device is
-in blocking or non-blocking mode. In the latter case, the call fails
-immediately with errno set to ``EWOULDBLOCK``. In the former case, the call
-blocks until an event becomes available. The standard Linux poll()
-and/or select() system calls can be used with the device file descriptor
-to watch for new events. For select(), the file descriptor should be
-included in the exceptfds argument, and for poll(), POLLPRI should be
-specified as the wake-up condition. Read-only permissions are sufficient
-for this ioctl call.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_EVENT for this command.
-
- - .. row 3
-
- - struct video_event \*ev
-
- - Points to the location where the event, if any, is to be stored.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EWOULDBLOCK``
-
- - There is no event pending, and the device is in non-blocking mode.
-
- - .. row 2
-
- - ``EOVERFLOW``
-
- - Overflow in event queue - one or more events were lost.
-
-
-
-.. _VIDEO_COMMAND:
-
-VIDEO_COMMAND
-=============
-
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the
-:ref:`VIDIOC_DECODER_CMD` ioctl.
-
-This ioctl commands the decoder. The ``video_command`` struct is a
-subset of the ``v4l2_decoder_cmd`` struct, so refer to the
-:ref:`VIDIOC_DECODER_CMD` documentation for
-more information.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_COMMAND for this command.
-
- - .. row 3
-
- - struct video_command \*cmd
-
- - Commands the decoder.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_TRY_COMMAND:
-
-VIDEO_TRY_COMMAND
-=================
-
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the
-:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
-
-This ioctl tries a decoder command. The ``video_command`` struct is a
-subset of the ``v4l2_decoder_cmd`` struct, so refer to the
-:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
-for more information.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_TRY_COMMAND for this command.
-
- - .. row 3
-
- - struct video_command \*cmd
-
- - Try a decoder command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_GET_SIZE:
-
-VIDEO_GET_SIZE
-==============
-
-Description
------------
-
-This ioctl returns the size and aspect ratio.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_SIZE for this command.
-
- - .. row 3
-
- - video_size_t \*size
-
- - Returns the size and aspect ratio.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_SET_DISPLAY_FORMAT:
-
-VIDEO_SET_DISPLAY_FORMAT
-========================
-
-Description
------------
-
-This ioctl call asks the Video Device to select the video format to be
-applied by the MPEG chip on the video.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_DISPLAY_FORMAT for this command.
-
- - .. row 3
-
- - video_display_format_t format
-
- - Selects the video format to be used.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_STILLPICTURE:
-
-VIDEO_STILLPICTURE
-==================
-
-Description
------------
-
-This ioctl call asks the Video Device to display a still picture
-(I-frame). The input data shall contain an I-frame. If the pointer is
-NULL, then the current displayed still picture is blanked.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_STILLPICTURE for this command.
-
- - .. row 3
-
- - struct video_still_picture \*sp
-
- - Pointer to a location where an I-frame and size is stored.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_FAST_FORWARD:
-
-VIDEO_FAST_FORWARD
-==================
-
-Description
------------
-
-This ioctl call asks the Video Device to skip decoding of N number of
-I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
-selected.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_FAST_FORWARD for this command.
-
- - .. row 3
-
- - int nFrames
-
- - The number of frames to skip.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EPERM``
-
- - Mode VIDEO_SOURCE_MEMORY not selected.
-
-
-
-.. _VIDEO_SLOWMOTION:
-
-VIDEO_SLOWMOTION
-================
-
-Description
------------
-
-This ioctl call asks the video device to repeat decoding frames N number
-of times. This call can only be used if VIDEO_SOURCE_MEMORY is
-selected.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SLOWMOTION for this command.
-
- - .. row 3
-
- - int nFrames
-
- - The number of times to repeat each frame.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EPERM``
-
- - Mode VIDEO_SOURCE_MEMORY not selected.
-
-
-
-.. _VIDEO_GET_CAPABILITIES:
-
-VIDEO_GET_CAPABILITIES
-======================
-
-Description
------------
-
-This ioctl call asks the video device about its decoding capabilities.
-On success it returns and integer which has bits set according to the
-defines in section ??.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_CAPABILITIES for this command.
-
- - .. row 3
-
- - unsigned int \*cap
-
- - Pointer to a location where to store the capability information.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_SET_ID:
-
-VIDEO_SET_ID
-============
-
-Description
------------
-
-This ioctl selects which sub-stream is to be decoded if a program or
-system stream is sent to the video device.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_ID for this command.
-
- - .. row 3
-
- - int id
-
- - video sub-stream id
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - Invalid sub-stream id.
-
-
-
-.. _VIDEO_CLEAR_BUFFER:
-
-VIDEO_CLEAR_BUFFER
-==================
-
-Description
------------
-
-This ioctl call clears all video buffers in the driver and in the
-decoder hardware.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_CLEAR_BUFFER for this command.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_SET_STREAMTYPE:
-
-VIDEO_SET_STREAMTYPE
-====================
-
-Description
------------
-
-This ioctl tells the driver which kind of stream to expect being written
-to it. If this call is not used the default of video PES is used. Some
-drivers might not support this call and always expect PES.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_STREAMTYPE for this command.
-
- - .. row 3
-
- - int type
-
- - stream type
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_SET_FORMAT:
-
-VIDEO_SET_FORMAT
-================
-
-Description
------------
-
-This ioctl sets the screen format (aspect ratio) of the connected output
-device (TV) so that the output of the decoder can be adjusted
-accordingly.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_FORMAT for this command.
-
- - .. row 3
-
- - video_format_t format
-
- - video format of TV as defined in section ??.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - format is not a valid video format.
-
-
-
-.. _VIDEO_SET_SYSTEM:
-
-VIDEO_SET_SYSTEM
-================
-
-Description
------------
-
-This ioctl sets the television output format. The format (see section
-??) may vary from the color format of the displayed MPEG stream. If the
-hardware is not able to display the requested format the call will
-return an error.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_FORMAT for this command.
-
- - .. row 3
-
- - video_system_t system
-
- - video system of TV output.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - system is not a valid or supported video system.
-
-
-
-.. _VIDEO_SET_HIGHLIGHT:
-
-VIDEO_SET_HIGHLIGHT
-===================
-
-Description
------------
-
-This ioctl sets the SPU highlight information for the menu access of a
-DVD.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_HIGHLIGHT for this command.
-
- - .. row 3
-
- - video_highlight_t \*vhilite
-
- - SPU Highlight information according to section ??.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-.. _VIDEO_SET_SPU:
-
-VIDEO_SET_SPU
-=============
-
-Description
------------
-
-This ioctl activates or deactivates SPU decoding in a DVD input stream.
-It can only be used, if the driver is able to handle a DVD stream.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_SPU for this command.
-
- - .. row 3
-
- - video_spu_t \*spu
-
- - SPU decoding (de)activation and subid setting according to section
- ??.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - input is not a valid spu setting or driver cannot handle SPU.
-
-
-
-.. _VIDEO_SET_SPU_PALETTE:
-
-VIDEO_SET_SPU_PALETTE
-=====================
-
-Description
------------
-
-This ioctl sets the SPU color palette.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_SPU_PALETTE for this command.
-
- - .. row 3
-
- - video_spu_palette_t \*palette
-
- - SPU palette according to section ??.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - input is not a valid palette or driver doesn’t handle SPU.
-
-
-
-.. _VIDEO_GET_NAVI:
-
-VIDEO_GET_NAVI
-==============
-
-Description
------------
-
-This ioctl returns navigational information from the DVD stream. This is
-especially needed if an encoded stream has to be decoded by the
-hardware.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_NAVI for this command.
-
- - .. row 3
-
- - video_navi_pack_t \*navipack
-
- - PCI or DSI pack (private stream 2) according to section ??.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EFAULT``
-
- - driver is not able to return navigational information
-
-
-
-.. _VIDEO_SET_ATTRIBUTES:
-
-VIDEO_SET_ATTRIBUTES
-====================
-
-Description
------------
-
-This ioctl is intended for DVD playback and allows you to set certain
-information about the stream. Some hardware may not need this
-information, but the call also tells the hardware to prepare for DVD
-playback.
-
-Synopsis
---------
-
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_SET_ATTRIBUTE for this command.
-
- - .. row 3
-
- - video_attributes_t vattr
-
- - video attributes according to section ??.
-
-
-Return Value
-------------
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - ``EINVAL``
-
- - input is not a valid attribute setting.
+.. toctree::
+ :maxdepth: 1
+
+ video-fopen
+ video-fclose
+ video-fwrite
+ video-stop
+ video-play
+ video-freeze
+ video-continue
+ video-select-source
+ video-set-blank
+ video-get-status
+ video-get-frame-count
+ video-get-pts
+ video-get-frame-rate
+ video-get-event
+ video-command
+ video-try-command
+ video-get-size
+ video-set-display-format
+ video-stillpicture
+ video-fast-forward
+ video-slowmotion
+ video-get-capabilities
+ video-set-id
+ video-clear-buffer
+ video-set-streamtype
+ video-set-format
+ video-set-system
+ video-set-highlight
+ video-set-spu
+ video-set-spu-palette
+ video-get-navi
+ video-set-attributes
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 02/54] doc-rst: linux_tv: reformat all syscall pages
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 01/54] doc-rst: linux_tv: split DVB function call documentation Mauro Carvalho Chehab
@ 2016-07-08 13:02 ` Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 03/54] doc-rst: linux_tv: dvb: use lowercase for filenames Mauro Carvalho Chehab
` (52 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=true, Size: 239318 bytes --]
The syscall pages are written to be used also as man-pages.
However, they don't match the format used by kernel-doc
generated pages from DocBook. Rewrite them to match it.
One side effect is that now all such pages at the book
will have the same format, reducing the format differences
between DVB and the other parts of the book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst | 39 ++++----
Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst | 33 ++++---
.../linux_tv/media/dvb/FE_GET_FRONTEND.rst | 27 ++---
.../linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst | 29 +++---
Documentation/linux_tv/media/dvb/FE_READ_SNR.rst | 29 +++---
.../media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst | 33 ++++---
.../linux_tv/media/dvb/FE_SET_FRONTEND.rst | 41 ++++----
.../media/dvb/audio-bilingual-channel-select.rst | 34 ++++---
.../linux_tv/media/dvb/audio-channel-select.rst | 32 +++---
.../linux_tv/media/dvb/audio-clear-buffer.rst | 26 ++---
.../linux_tv/media/dvb/audio-continue.rst | 26 ++---
Documentation/linux_tv/media/dvb/audio-fclose.rst | 27 ++---
Documentation/linux_tv/media/dvb/audio-fopen.rst | 109 +++++++++++----------
Documentation/linux_tv/media/dvb/audio-fwrite.rst | 35 +++----
.../linux_tv/media/dvb/audio-get-capabilities.rst | 26 ++---
Documentation/linux_tv/media/dvb/audio-get-pts.rst | 34 ++++---
.../linux_tv/media/dvb/audio-get-status.rst | 26 ++---
Documentation/linux_tv/media/dvb/audio-pause.rst | 28 +++---
Documentation/linux_tv/media/dvb/audio-play.rst | 26 ++---
.../linux_tv/media/dvb/audio-select-source.rst | 30 +++---
.../linux_tv/media/dvb/audio-set-attributes.rst | 27 ++---
.../linux_tv/media/dvb/audio-set-av-sync.rst | 26 ++---
.../linux_tv/media/dvb/audio-set-bypass-mode.rst | 32 +++---
.../linux_tv/media/dvb/audio-set-ext-id.rst | 27 ++---
Documentation/linux_tv/media/dvb/audio-set-id.rst | 36 ++++---
.../linux_tv/media/dvb/audio-set-karaoke.rst | 22 +++--
.../linux_tv/media/dvb/audio-set-mixer.rst | 24 +++--
.../linux_tv/media/dvb/audio-set-mute.rst | 34 ++++---
.../linux_tv/media/dvb/audio-set-streamtype.rst | 29 +++---
Documentation/linux_tv/media/dvb/audio-stop.rst | 26 ++---
Documentation/linux_tv/media/dvb/ca-fclose.rst | 27 ++---
Documentation/linux_tv/media/dvb/ca-fopen.rst | 49 ++++-----
Documentation/linux_tv/media/dvb/ca-get-cap.rst | 24 +++--
.../linux_tv/media/dvb/ca-get-descr-info.rst | 24 +++--
Documentation/linux_tv/media/dvb/ca-get-msg.rst | 24 +++--
.../linux_tv/media/dvb/ca-get-slot-info.rst | 24 +++--
Documentation/linux_tv/media/dvb/ca-reset.rst | 24 +++--
Documentation/linux_tv/media/dvb/ca-send-msg.rst | 24 +++--
Documentation/linux_tv/media/dvb/ca-set-descr.rst | 24 +++--
Documentation/linux_tv/media/dvb/ca-set-pid.rst | 22 +++--
Documentation/linux_tv/media/dvb/dmx-add-pid.rst | 28 +++---
Documentation/linux_tv/media/dvb/dmx-fclose.rst | 29 +++---
Documentation/linux_tv/media/dvb/dmx-fopen.rst | 99 ++++++++++---------
Documentation/linux_tv/media/dvb/dmx-fread.rst | 33 ++++---
Documentation/linux_tv/media/dvb/dmx-fwrite.rst | 37 +++----
Documentation/linux_tv/media/dvb/dmx-get-caps.rst | 24 +++--
Documentation/linux_tv/media/dvb/dmx-get-event.rst | 33 ++++---
.../linux_tv/media/dvb/dmx-get-pes-pids.rst | 24 +++--
Documentation/linux_tv/media/dvb/dmx-get-stc.rst | 35 ++++---
.../linux_tv/media/dvb/dmx-remove-pid.rst | 28 +++---
.../linux_tv/media/dvb/dmx-set-buffer-size.rst | 30 +++---
.../linux_tv/media/dvb/dmx-set-filter.rst | 42 ++++----
.../linux_tv/media/dvb/dmx-set-pes-filter.rst | 31 +++---
.../linux_tv/media/dvb/dmx-set-source.rst | 24 +++--
Documentation/linux_tv/media/dvb/dmx-start.rst | 27 ++---
Documentation/linux_tv/media/dvb/dmx-stop.rst | 28 +++---
.../media/dvb/fe-diseqc-recv-slave-reply.rst | 15 +--
.../media/dvb/fe-diseqc-reset-overload.rst | 16 +--
.../linux_tv/media/dvb/fe-diseqc-send-burst.rst | 15 +--
.../media/dvb/fe-diseqc-send-master-cmd.rst | 15 +--
.../media/dvb/fe-enable-high-lnb-voltage.rst | 16 +--
Documentation/linux_tv/media/dvb/fe-get-info.rst | 16 +--
.../linux_tv/media/dvb/fe-get-property.rst | 17 ++--
.../linux_tv/media/dvb/fe-read-status.rst | 16 +--
.../media/dvb/fe-set-frontend-tune-mode.rst | 15 +--
Documentation/linux_tv/media/dvb/fe-set-tone.rst | 15 +--
.../linux_tv/media/dvb/fe-set-voltage.rst | 15 +--
.../linux_tv/media/dvb/frontend_f_close.rst | 15 +--
.../linux_tv/media/dvb/frontend_f_open.rst | 15 +--
Documentation/linux_tv/media/dvb/net-add-if.rst | 15 +--
Documentation/linux_tv/media/dvb/net-get-if.rst | 17 ++--
Documentation/linux_tv/media/dvb/net-remove-if.rst | 15 +--
.../linux_tv/media/dvb/video-clear-buffer.rst | 26 ++---
Documentation/linux_tv/media/dvb/video-command.rst | 38 +++----
.../linux_tv/media/dvb/video-continue.rst | 32 +++---
.../linux_tv/media/dvb/video-fast-forward.rst | 29 +++---
Documentation/linux_tv/media/dvb/video-fclose.rst | 27 ++---
Documentation/linux_tv/media/dvb/video-fopen.rst | 107 ++++++++++----------
Documentation/linux_tv/media/dvb/video-freeze.rst | 40 ++++----
Documentation/linux_tv/media/dvb/video-fwrite.rst | 35 +++----
.../linux_tv/media/dvb/video-get-capabilities.rst | 28 +++---
.../linux_tv/media/dvb/video-get-event.rst | 79 ++++++++-------
.../linux_tv/media/dvb/video-get-frame-count.rst | 34 ++++---
.../linux_tv/media/dvb/video-get-frame-rate.rst | 24 +++--
.../linux_tv/media/dvb/video-get-navi.rst | 29 +++---
Documentation/linux_tv/media/dvb/video-get-pts.rst | 34 ++++---
.../linux_tv/media/dvb/video-get-size.rst | 24 +++--
.../linux_tv/media/dvb/video-get-status.rst | 26 ++---
Documentation/linux_tv/media/dvb/video-play.rst | 32 +++---
.../linux_tv/media/dvb/video-select-source.rst | 36 ++++---
.../linux_tv/media/dvb/video-set-attributes.rst | 28 +++---
.../linux_tv/media/dvb/video-set-blank.rst | 24 +++--
.../media/dvb/video-set-display-format.rst | 26 ++---
.../linux_tv/media/dvb/video-set-format.rst | 29 +++---
.../linux_tv/media/dvb/video-set-highlight.rst | 26 ++---
Documentation/linux_tv/media/dvb/video-set-id.rst | 27 ++---
.../linux_tv/media/dvb/video-set-spu-palette.rst | 25 ++---
Documentation/linux_tv/media/dvb/video-set-spu.rst | 27 ++---
.../linux_tv/media/dvb/video-set-streamtype.rst | 28 +++---
.../linux_tv/media/dvb/video-set-system.rst | 31 +++---
.../linux_tv/media/dvb/video-slowmotion.rst | 29 +++---
.../linux_tv/media/dvb/video-stillpicture.rst | 28 +++---
Documentation/linux_tv/media/dvb/video-stop.rst | 34 ++++---
.../linux_tv/media/dvb/video-try-command.rst | 38 +++----
.../linux_tv/media/mediactl/media-func-close.rst | 15 +--
.../linux_tv/media/mediactl/media-func-ioctl.rst | 15 +--
.../linux_tv/media/mediactl/media-func-open.rst | 15 +--
.../media/mediactl/media-ioc-device-info.rst | 15 +--
.../media/mediactl/media-ioc-enum-entities.rst | 16 +--
.../media/mediactl/media-ioc-enum-links.rst | 16 +--
.../media/mediactl/media-ioc-g-topology.rst | 16 +--
.../media/mediactl/media-ioc-setup-link.rst | 15 +--
Documentation/linux_tv/media/v4l/func-close.rst | 15 +--
Documentation/linux_tv/media/v4l/func-ioctl.rst | 15 +--
Documentation/linux_tv/media/v4l/func-mmap.rst | 15 +--
Documentation/linux_tv/media/v4l/func-munmap.rst | 15 +--
Documentation/linux_tv/media/v4l/func-open.rst | 15 +--
Documentation/linux_tv/media/v4l/func-poll.rst | 18 ++--
Documentation/linux_tv/media/v4l/func-read.rst | 15 +--
Documentation/linux_tv/media/v4l/func-select.rst | 18 ++--
Documentation/linux_tv/media/v4l/func-write.rst | 15 +--
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 16 +--
.../linux_tv/media/v4l/vidioc-cropcap.rst | 16 +--
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 16 +--
.../linux_tv/media/v4l/vidioc-dbg-g-register.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-decoder-cmd.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-dqevent.rst | 16 +--
.../linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-encoder-cmd.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-enum-fmt.rst | 16 +--
.../media/v4l/vidioc-enum-frameintervals.rst | 16 +--
.../linux_tv/media/v4l/vidioc-enum-framesizes.rst | 16 +--
.../linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 16 +--
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 15 +--
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 15 +--
.../linux_tv/media/v4l/vidioc-enuminput.rst | 16 +--
.../linux_tv/media/v4l/vidioc-enumoutput.rst | 16 +--
.../linux_tv/media/v4l/vidioc-enumstd.rst | 16 +--
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 16 +--
.../linux_tv/media/v4l/vidioc-g-audio.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-g-audioout.rst | 17 ++--
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 17 ++--
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 18 ++--
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 19 ++--
.../linux_tv/media/v4l/vidioc-g-enc-index.rst | 16 +--
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 18 ++--
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 17 ++--
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 18 ++--
.../linux_tv/media/v4l/vidioc-g-frequency.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-g-input.rst | 16 +--
.../linux_tv/media/v4l/vidioc-g-jpegcomp.rst | 15 +--
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-g-output.rst | 16 +--
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-g-priority.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-g-selection.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 16 +--
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 16 +--
.../linux_tv/media/v4l/vidioc-g-tuner.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-log-status.rst | 18 ++--
.../linux_tv/media/v4l/vidioc-overlay.rst | 15 +--
.../linux_tv/media/v4l/vidioc-prepare-buf.rst | 15 +--
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 16 +--
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 16 +--
.../linux_tv/media/v4l/vidioc-querybuf.rst | 15 +--
.../linux_tv/media/v4l/vidioc-querycap.rst | 16 +--
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 18 ++--
.../linux_tv/media/v4l/vidioc-querystd.rst | 15 +--
.../linux_tv/media/v4l/vidioc-reqbufs.rst | 16 +--
.../linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 16 +--
.../linux_tv/media/v4l/vidioc-streamon.rst | 16 +--
.../v4l/vidioc-subdev-enum-frame-interval.rst | 16 +--
.../media/v4l/vidioc-subdev-enum-frame-size.rst | 16 +--
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 16 +--
.../linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-subdev-g-fmt.rst | 18 ++--
.../media/v4l/vidioc-subdev-g-frame-interval.rst | 17 ++--
.../media/v4l/vidioc-subdev-g-selection.rst | 17 ++--
.../linux_tv/media/v4l/vidioc-subscribe-event.rst | 17 ++--
181 files changed, 2364 insertions(+), 2007 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst b/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
index ff94ac9122d0..9435f45f58c3 100644
--- a/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
+++ b/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
@@ -6,27 +6,19 @@
FE_DISHNETWORK_SEND_LEGACY_CMD
******************************
-Description
------------
+NAME
+====
-WARNING: This is a very obscure legacy command, used only at stv0299
-driver. Should not be used on newer drivers.
+FE_DISHNETWORK_SEND_LEGACY_CMD
-It provides a non-standard method for selecting Diseqc voltage on the
-frontend, for Dish Network legacy switches.
-
-As support for this ioctl were added in 2004, this means that such
-dishes were already legacy in 2004.
-
-Synopsis
---------
+SYNOPSIS
+========
.. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
-Arguments
-----------
-
+ARGUMENTS
+=========
.. flat-table::
:header-rows: 0
@@ -40,8 +32,21 @@ Arguments
- sends the specified raw cmd to the dish via DISEqC.
-Return Value
-------------
+DESCRIPTION
+===========
+
+WARNING: This is a very obscure legacy command, used only at stv0299
+driver. Should not be used on newer drivers.
+
+It provides a non-standard method for selecting Diseqc voltage on the
+frontend, for Dish Network legacy switches.
+
+As support for this ioctl were added in 2004, this means that such
+dishes were already legacy in 2004.
+
+
+RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
index 24352b26a201..3d858107b6f9 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
@@ -6,24 +6,19 @@
FE_GET_EVENT
************
-Description
------------
+NAME
+====
-This ioctl call returns a frontend event if available. If an event is
-not available, the behavior depends on whether the device is in blocking
-or non-blocking mode. In the latter case, the call fails immediately
-with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
-an event becomes available.
+FE_GET_EVENT
-Synopsis
---------
+SYNOPSIS
+========
.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
-Arguments
-----------
-
+ARGUMENTS
+=========
.. flat-table::
:header-rows: 0
@@ -54,8 +49,18 @@ Arguments
- if any, is to be stored.
-Return Value
-------------
+DESCRIPTION
+===========
+
+This ioctl call returns a frontend event if available. If an event is
+not available, the behavior depends on whether the device is in blocking
+or non-blocking mode. In the latter case, the call fails immediately
+with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
+an event becomes available.
+
+
+RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
index d8dbcc7741d4..7084070bfe77 100644
--- a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
@@ -6,21 +6,19 @@
FE_GET_FRONTEND
***************
-Description
------------
+NAME
+====
-This ioctl call queries the currently effective frontend parameters. For
-this command, read-only access to the device is sufficient.
+FE_GET_FRONTEND
-Synopsis
---------
+SYNOPSIS
+========
.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
-Arguments
-----------
-
+ARGUMENTS
+=========
.. flat-table::
:header-rows: 0
@@ -47,8 +45,15 @@ Arguments
- Points to parameters for tuning operation.
-Return Value
-------------
+DESCRIPTION
+===========
+
+This ioctl call queries the currently effective frontend parameters. For
+this command, read-only access to the device is sufficient.
+
+
+RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
index 4adea9274d37..7f6f47f4d30e 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
@@ -6,22 +6,19 @@
FE_READ_SIGNAL_STRENGTH
***********************
-Description
------------
+NAME
+====
-This ioctl call returns the signal strength value for the signal
-currently received by the front-end. For this command, read-only access
-to the device is sufficient.
+FE_READ_SIGNAL_STRENGTH
-Synopsis
---------
+SYNOPSIS
+========
.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
-Arguments
-----------
-
+ARGUMENTS
+=========
.. flat-table::
:header-rows: 0
@@ -49,8 +46,16 @@ Arguments
- The signal strength value is stored into \*strength.
-Return Value
-------------
+DESCRIPTION
+===========
+
+This ioctl call returns the signal strength value for the signal
+currently received by the front-end. For this command, read-only access
+to the device is sufficient.
+
+
+RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
index 11b4f72d684e..3ecaeb8007f4 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
@@ -6,22 +6,19 @@
FE_READ_SNR
***********
-Description
------------
+NAME
+====
-This ioctl call returns the signal-to-noise ratio for the signal
-currently received by the front-end. For this command, read-only access
-to the device is sufficient.
+FE_READ_SNR
-Synopsis
---------
+SYNOPSIS
+========
.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
-Arguments
-----------
-
+ARGUMENTS
+=========
.. flat-table::
:header-rows: 0
@@ -47,8 +44,16 @@ Arguments
- The signal-to-noise ratio is stored into \*snr.
-Return Value
-------------
+DESCRIPTION
+===========
+
+This ioctl call returns the signal-to-noise ratio for the signal
+currently received by the front-end. For this command, read-only access
+to the device is sufficient.
+
+
+RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst b/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
index cb35a416b1e4..31ec4c35dd51 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
@@ -6,24 +6,19 @@
FE_READ_UNCORRECTED_BLOCKS
**************************
-Description
------------
+NAME
+====
-This ioctl call returns the number of uncorrected blocks detected by the
-device driver during its lifetime. For meaningful measurements, the
-increment in block count during a specific time interval should be
-calculated. For this command, read-only access to the device is
-sufficient.
+FE_READ_UNCORRECTED_BLOCKS
-Synopsis
---------
+SYNOPSIS
+========
.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
-Arguments
-----------
-
+ARGUMENTS
+=========
.. flat-table::
:header-rows: 0
@@ -51,8 +46,18 @@ Arguments
- The total number of uncorrected blocks seen by the driver so far.
-Return Value
-------------
+DESCRIPTION
+===========
+
+This ioctl call returns the number of uncorrected blocks detected by the
+device driver during its lifetime. For meaningful measurements, the
+increment in block count during a specific time interval should be
+calculated. For this command, read-only access to the device is
+sufficient.
+
+
+RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
index 98970961da7b..0cce39666773 100644
--- a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
+++ b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
@@ -6,28 +6,19 @@
FE_SET_FRONTEND
***************
-Description
------------
+NAME
+====
-This ioctl call starts a tuning operation using specified parameters.
-The result of this call will be successful if the parameters were valid
-and the tuning could be initiated. The result of the tuning operation in
-itself, however, will arrive asynchronously as an event (see
-documentation for :ref:`FE_GET_EVENT` and
-FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
-operation is initiated before the previous one was completed, the
-previous operation will be aborted in favor of the new one. This command
-requires read/write access to the device.
+FE_SET_FRONTEND
-Synopsis
---------
+SYNOPSIS
+========
.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
-Arguments
-----------
-
+ARGUMENTS
+=========
.. flat-table::
:header-rows: 0
@@ -54,8 +45,22 @@ Arguments
- Points to parameters for tuning operation.
-Return Value
-------------
+DESCRIPTION
+===========
+
+This ioctl call starts a tuning operation using specified parameters.
+The result of this call will be successful if the parameters were valid
+and the tuning could be initiated. The result of the tuning operation in
+itself, however, will arrive asynchronously as an event (see
+documentation for :ref:`FE_GET_EVENT` and
+FrontendEvent.) If a new :ref:`FE_SET_FRONTEND`
+operation is initiated before the previous one was completed, the
+previous operation will be aborted in favor of the new one. This command
+requires read/write access to the device.
+
+
+RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
index b965932fe20c..dda1695e28a9 100644
--- a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
+++ b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
@@ -2,28 +2,23 @@
.. _AUDIO_BILINGUAL_CHANNEL_SELECT:
+==============================
AUDIO_BILINGUAL_CHANNEL_SELECT
==============================
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. It has been replaced
-by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control
-for MPEG decoders controlled through V4L2.
+NAME
+----
-This ioctl call asks the Audio Device to select the requested channel
-for bilingual streams if possible.
+AUDIO_BILINGUAL_CHANNEL_SELECT
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -49,11 +44,20 @@ Arguments
- Select the output format of the audio (mono left/right, stereo).
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. It has been replaced
+by the V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` control
+for MPEG decoders controlled through V4L2.
+
+This ioctl call asks the Audio Device to select the requested channel
+for bilingual streams if possible.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
index d570ff1f7d3a..f7f9766d3902 100644
--- a/Documentation/linux_tv/media/dvb/audio-channel-select.rst
+++ b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
@@ -2,27 +2,23 @@
.. _AUDIO_CHANNEL_SELECT:
+====================
AUDIO_CHANNEL_SELECT
====================
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
+NAME
+----
-This ioctl call asks the Audio Device to select the requested channel if
-possible.
+AUDIO_CHANNEL_SELECT
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -48,11 +44,19 @@ Arguments
- Select the output format of the audio (mono left/right, stereo).
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead.
+
+This ioctl call asks the Audio Device to select the requested channel if
+possible.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
index 6c94cc7402a9..97cb3d98f20d 100644
--- a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
+++ b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
@@ -2,24 +2,23 @@
.. _AUDIO_CLEAR_BUFFER:
+==================
AUDIO_CLEAR_BUFFER
==================
-Description
------------
+NAME
+----
-This ioctl call asks the Audio Device to clear all software and hardware
-buffers of the audio decoder device.
+AUDIO_CLEAR_BUFFER
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -39,11 +38,16 @@ Arguments
- Equals AUDIO_CLEAR_BUFFER for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Audio Device to clear all software and hardware
+buffers of the audio decoder device.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-continue.rst b/Documentation/linux_tv/media/dvb/audio-continue.rst
index 8b91cf950765..1f3d5c35b7ce 100644
--- a/Documentation/linux_tv/media/dvb/audio-continue.rst
+++ b/Documentation/linux_tv/media/dvb/audio-continue.rst
@@ -2,24 +2,23 @@
.. _AUDIO_CONTINUE:
+==============
AUDIO_CONTINUE
==============
-Description
------------
+NAME
+----
-This ioctl restarts the decoding and playing process previously paused
-with AUDIO_PAUSE command.
+AUDIO_CONTINUE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -39,11 +38,16 @@ Arguments
- Equals AUDIO_CONTINUE for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl restarts the decoding and playing process previously paused
+with AUDIO_PAUSE command.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-fclose.rst b/Documentation/linux_tv/media/dvb/audio-fclose.rst
index fb855dd9cbcb..80d9cde4c926 100644
--- a/Documentation/linux_tv/media/dvb/audio-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fclose.rst
@@ -2,23 +2,23 @@
.. _audio_fclose:
+=================
DVB audio close()
=================
-Description
------------
+NAME
+----
-This system call closes a previously opened audio device.
+DVB audio close()
-Synopsis
+SYNOPSIS
--------
.. c:function:: int close(int fd)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -32,11 +32,15 @@ Arguments
- File descriptor returned by a previous call to open().
-Return Value
+DESCRIPTION
+-----------
+
+This system call closes a previously opened audio device.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -47,6 +51,3 @@ Return Value
- ``EBADF``
- fd is not a valid open file descriptor.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-fopen.rst b/Documentation/linux_tv/media/dvb/audio-fopen.rst
index 5d3d7d941567..6596d6427c1f 100644
--- a/Documentation/linux_tv/media/dvb/audio-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fopen.rst
@@ -2,10 +2,63 @@
.. _audio_fopen:
+================
DVB audio open()
================
-Description
+NAME
+----
+
+DVB audio open()
+
+SYNOPSIS
+--------
+
+.. c:function:: int open(const char *deviceName, int flags)
+
+
+ARGUMENTS
+---------
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - const char \*deviceName
+
+ - Name of specific audio device.
+
+ - .. row 2
+
+ - int flags
+
+ - A bit-wise OR of the following flags:
+
+ - .. row 3
+
+ -
+ - O_RDONLY read-only access
+
+ - .. row 4
+
+ -
+ - O_RDWR read/write access
+
+ - .. row 5
+
+ -
+ - O_NONBLOCK open in non-blocking mode
+
+ - .. row 6
+
+ -
+ - (blocking mode is the default)
+
+
+DESCRIPTION
-----------
This system call opens a named audio device (e.g.
@@ -22,59 +75,10 @@ fail, and an error code will be returned. If the Audio Device is opened
in O_RDONLY mode, the only ioctl call that can be used is
AUDIO_GET_STATUS. All other call will return with an error code.
-Synopsis
---------
-.. c:function:: int open(const char *deviceName, int flags)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - const char \*deviceName
-
- - Name of specific audio device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDONLY read-only access
-
- - .. row 4
-
- -
- - O_RDWR read/write access
-
- - .. row 5
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 6
-
- -
- - (blocking mode is the default)
-
-
-Return Value
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -97,6 +101,3 @@ Return Value
- ``EINVAL``
- Invalid argument.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-fwrite.rst b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
index 9921f3a16d45..9aa9583a3267 100644
--- a/Documentation/linux_tv/media/dvb/audio-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
@@ -2,27 +2,23 @@
.. _audio_fwrite:
+=================
DVB audio write()
=================
-Description
------------
+NAME
+----
-This system call can only be used if AUDIO_SOURCE_MEMORY is selected
-in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in
-PES format. If O_NONBLOCK is not specified the function will block
-until buffer space is available. The amount of data to be transferred is
-implied by count.
+DVB audio write()
-Synopsis
+SYNOPSIS
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -48,11 +44,19 @@ Arguments
- Size of buf.
-Return Value
+DESCRIPTION
+-----------
+
+This system call can only be used if AUDIO_SOURCE_MEMORY is selected
+in the ioctl call AUDIO_SELECT_SOURCE. The data provided shall be in
+PES format. If O_NONBLOCK is not specified the function will block
+until buffer space is available. The amount of data to be transferred is
+implied by count.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -75,6 +79,3 @@ Return Value
- ``EBADF``
- fd is not a valid open file descriptor.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
index 84b9f073344b..32e55bbc4d03 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
@@ -2,24 +2,23 @@
.. _AUDIO_GET_CAPABILITIES:
+======================
AUDIO_GET_CAPABILITIES
======================
-Description
------------
+NAME
+----
-This ioctl call asks the Audio Device to tell us about the decoding
-capabilities of the audio hardware.
+AUDIO_GET_CAPABILITIES
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,11 +44,16 @@ Arguments
- Returns a bit array of supported sound formats.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Audio Device to tell us about the decoding
+capabilities of the audio hardware.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-get-pts.rst b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
index 3cd31741e728..a8e2ef5a107d 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-pts.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
@@ -2,28 +2,23 @@
.. _AUDIO_GET_PTS:
+=============
AUDIO_GET_PTS
=============
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. If you need this
-functionality, then please contact the linux-media mailing list
-(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__).
+NAME
+----
-This ioctl call asks the Audio Device to return the current PTS
-timestamp.
+AUDIO_GET_PTS
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -54,11 +49,20 @@ Arguments
decoded frame or the last PTS extracted by the PES parser.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. If you need this
+functionality, then please contact the linux-media mailing list
+(`https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__).
+
+This ioctl call asks the Audio Device to return the current PTS
+timestamp.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-get-status.rst b/Documentation/linux_tv/media/dvb/audio-get-status.rst
index be0937fbff0c..b9a2850b577a 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-status.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-status.rst
@@ -2,24 +2,23 @@
.. _AUDIO_GET_STATUS:
+================
AUDIO_GET_STATUS
================
-Description
------------
+NAME
+----
-This ioctl call asks the Audio Device to return the current state of the
-Audio Device.
+AUDIO_GET_STATUS
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,11 +44,16 @@ Arguments
- Returns the current state of Audio Device.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Audio Device to return the current state of the
+Audio Device.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-pause.rst b/Documentation/linux_tv/media/dvb/audio-pause.rst
index 2d1c7e880ad0..8b1517b54272 100644
--- a/Documentation/linux_tv/media/dvb/audio-pause.rst
+++ b/Documentation/linux_tv/media/dvb/audio-pause.rst
@@ -2,25 +2,23 @@
.. _AUDIO_PAUSE:
+===========
AUDIO_PAUSE
===========
-Description
------------
+NAME
+----
-This ioctl call suspends the audio stream being played. Decoding and
-playing are paused. It is then possible to restart again decoding and
-playing process of the audio stream using AUDIO_CONTINUE command.
+AUDIO_PAUSE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -40,11 +38,17 @@ Arguments
- Equals AUDIO_PAUSE for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call suspends the audio stream being played. Decoding and
+playing are paused. It is then possible to restart again decoding and
+playing process of the audio stream using AUDIO_CONTINUE command.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-play.rst b/Documentation/linux_tv/media/dvb/audio-play.rst
index 116cc27be82c..22bd35007b25 100644
--- a/Documentation/linux_tv/media/dvb/audio-play.rst
+++ b/Documentation/linux_tv/media/dvb/audio-play.rst
@@ -2,24 +2,23 @@
.. _AUDIO_PLAY:
+==========
AUDIO_PLAY
==========
-Description
------------
+NAME
+----
-This ioctl call asks the Audio Device to start playing an audio stream
-from the selected source.
+AUDIO_PLAY
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -39,11 +38,16 @@ Arguments
- Equals AUDIO_PLAY for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Audio Device to start playing an audio stream
+from the selected source.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-select-source.rst b/Documentation/linux_tv/media/dvb/audio-select-source.rst
index 9d6367e7ff6f..2242e6f0b6ad 100644
--- a/Documentation/linux_tv/media/dvb/audio-select-source.rst
+++ b/Documentation/linux_tv/media/dvb/audio-select-source.rst
@@ -2,26 +2,23 @@
.. _AUDIO_SELECT_SOURCE:
+===================
AUDIO_SELECT_SOURCE
===================
-Description
------------
+NAME
+----
-This ioctl call informs the audio device which source shall be used for
-the input data. The possible sources are demux or memory. If
-AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device
-through the write command.
+AUDIO_SELECT_SOURCE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -47,11 +44,18 @@ Arguments
- Indicates the source that shall be used for the Audio stream.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call informs the audio device which source shall be used for
+the input data. The possible sources are demux or memory. If
+AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device
+through the write command.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
index a03774015b40..ea08cea6aa78 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
@@ -2,24 +2,23 @@
.. _AUDIO_SET_ATTRIBUTES:
+====================
AUDIO_SET_ATTRIBUTES
====================
-Description
------------
+NAME
+----
-This ioctl is intended for DVD playback and allows you to set certain
-information about the audio stream.
+AUDIO_SET_ATTRIBUTES
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,7 +44,14 @@ Arguments
- audio attributes according to section ??
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is intended for DVD playback and allows you to set certain
+information about the audio stream.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -64,6 +70,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- attr is not a valid or supported attribute setting.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
index 7aa27ab34d91..3f5ac9a87bc8 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
@@ -2,24 +2,23 @@
.. _AUDIO_SET_AV_SYNC:
+=================
AUDIO_SET_AV_SYNC
=================
-Description
------------
+NAME
+----
-This ioctl call asks the Audio Device to turn ON or OFF A/V
-synchronization.
+AUDIO_SET_AV_SYNC
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -55,11 +54,16 @@ Arguments
- FALSE AV-sync OFF
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Audio Device to turn ON or OFF A/V
+synchronization.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
index 3a0c21a667fa..9377342c646d 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
@@ -2,27 +2,23 @@
.. _AUDIO_SET_BYPASS_MODE:
+=====================
AUDIO_SET_BYPASS_MODE
=====================
-Description
------------
+NAME
+----
-This ioctl call asks the Audio Device to bypass the Audio decoder and
-forward the stream without decoding. This mode shall be used if streams
-that can’t be handled by the DVB system shall be decoded. Dolby
-DigitalTM streams are automatically forwarded by the DVB subsystem if
-the hardware can handle it.
+AUDIO_SET_BYPASS_MODE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -59,11 +55,19 @@ Arguments
- FALSE Bypass is enabled
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Audio Device to bypass the Audio decoder and
+forward the stream without decoding. This mode shall be used if streams
+that can’t be handled by the DVB system shall be decoded. Dolby
+DigitalTM streams are automatically forwarded by the DVB subsystem if
+the hardware can handle it.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
index bda4c92df27f..456b05267f29 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
@@ -2,24 +2,23 @@
.. _AUDIO_SET_EXT_ID:
+================
AUDIO_SET_EXT_ID
================
-Description
------------
+NAME
+----
-This ioctl can be used to set the extension id for MPEG streams in DVD
-playback. Only the first 3 bits are recognized.
+AUDIO_SET_EXT_ID
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,7 +44,14 @@ Arguments
- audio sub_stream_id
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl can be used to set the extension id for MPEG streams in DVD
+playback. Only the first 3 bits are recognized.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -64,6 +70,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- id is not a valid id.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-id.rst b/Documentation/linux_tv/media/dvb/audio-set-id.rst
index e545f9dad407..60eeee07d244 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-id.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-id.rst
@@ -2,29 +2,23 @@
.. _AUDIO_SET_ID:
+============
AUDIO_SET_ID
============
-Description
------------
+NAME
+----
-This ioctl selects which sub-stream is to be decoded if a program or
-system stream is sent to the video device. If no audio stream type is
-set the id has to be in [0xC0,0xDF] for MPEG sound, in [0x80,0x87] for
-AC3 and in [0xA0,0xA7] for LPCM. More specifications may follow for
-other stream types. If the stream type is set the id just specifies the
-substream id of the audio stream and only the first 5 bits are
-recognized.
+AUDIO_SET_ID
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -50,11 +44,21 @@ Arguments
- audio sub-stream id
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl selects which sub-stream is to be decoded if a program or
+system stream is sent to the video device. If no audio stream type is
+set the id has to be in [0xC0,0xDF] for MPEG sound, in [0x80,0x87] for
+AC3 and in [0xA0,0xA7] for LPCM. More specifications may follow for
+other stream types. If the stream type is set the id just specifies the
+substream id of the audio stream and only the first 5 bits are
+recognized.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
index 75a02e4db0a1..07453ceae40f 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
@@ -2,23 +2,23 @@
.. _AUDIO_SET_KARAOKE:
+=================
AUDIO_SET_KARAOKE
=================
-Description
------------
+NAME
+----
-This ioctl allows one to set the mixer settings for a karaoke DVD.
+AUDIO_SET_KARAOKE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,7 +44,13 @@ Arguments
- karaoke settings according to section ??.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl allows one to set the mixer settings for a karaoke DVD.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
index 9360d20e759e..8d5a6f375419 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
@@ -2,23 +2,23 @@
.. _AUDIO_SET_MIXER:
+===============
AUDIO_SET_MIXER
===============
-Description
------------
+NAME
+----
-This ioctl lets you adjust the mixer settings of the audio decoder.
+AUDIO_SET_MIXER
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- mixer settings.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl lets you adjust the mixer settings of the audio decoder.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mute.rst b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
index eb6622b63e2b..a002d0d7128d 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-mute.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
@@ -2,28 +2,23 @@
.. _AUDIO_SET_MUTE:
+==============
AUDIO_SET_MUTE
==============
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` with the
-``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
+NAME
+----
-This ioctl call asks the audio device to mute the stream that is
-currently being played.
+AUDIO_SET_MUTE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -59,11 +54,20 @@ Arguments
- FALSE Audio Un-mute
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` with the
+``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead.
+
+This ioctl call asks the audio device to mute the stream that is
+currently being played.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
index 6fc7c8dfccf8..a971d43e01cc 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
@@ -2,25 +2,23 @@
.. _AUDIO_SET_STREAMTYPE:
+====================
AUDIO_SET_STREAMTYPE
====================
-Description
------------
+NAME
+----
-This ioctl tells the driver which kind of audio stream to expect. This
-is useful if the stream offers several audio sub-streams like LPCM and
-AC3.
+AUDIO_SET_STREAMTYPE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,7 +44,15 @@ Arguments
- stream type
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl tells the driver which kind of audio stream to expect. This
+is useful if the stream offers several audio sub-streams like LPCM and
+AC3.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -65,6 +71,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- type is not a valid or supported stream type.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/audio-stop.rst b/Documentation/linux_tv/media/dvb/audio-stop.rst
index 57e95c453350..558ff2b1effb 100644
--- a/Documentation/linux_tv/media/dvb/audio-stop.rst
+++ b/Documentation/linux_tv/media/dvb/audio-stop.rst
@@ -2,24 +2,23 @@
.. _AUDIO_STOP:
+==========
AUDIO_STOP
==========
-Description
------------
+NAME
+----
-This ioctl call asks the Audio Device to stop playing the current
-stream.
+AUDIO_STOP
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -39,11 +38,16 @@ Arguments
- Equals AUDIO_STOP for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Audio Device to stop playing the current
+stream.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-fclose.rst b/Documentation/linux_tv/media/dvb/ca-fclose.rst
index c7797c726c6b..a093e8dd3182 100644
--- a/Documentation/linux_tv/media/dvb/ca-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/ca-fclose.rst
@@ -2,23 +2,23 @@
.. _ca_fclose:
+==============
DVB CA close()
==============
-Description
------------
+NAME
+----
-This system call closes a previously opened audio device.
+DVB CA close()
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int close(int fd)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -32,11 +32,15 @@ Arguments
- File descriptor returned by a previous call to open().
-Return Value
+DESCRIPTION
+-----------
+
+This system call closes a previously opened audio device.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -47,6 +51,3 @@ Return Value
- ``EBADF``
- fd is not a valid open file descriptor.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-fopen.rst b/Documentation/linux_tv/media/dvb/ca-fopen.rst
index 316209439f88..a9bf45a921e9 100644
--- a/Documentation/linux_tv/media/dvb/ca-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/ca-fopen.rst
@@ -2,34 +2,23 @@
.. _ca_fopen:
+=============
DVB CA open()
=============
-Description
------------
-
-This system call opens a named ca device (e.g. /dev/ost/ca) for
-subsequent use.
+NAME
+----
-When an open() call has succeeded, the device will be ready for use. The
-significance of blocking or non-blocking mode is described in the
-documentation for functions where there is a difference. It does not
-affect the semantics of the open() call itself. A device opened in
-blocking mode can later be put into non-blocking mode (and vice versa)
-using the F_SETFL command of the fcntl system call. This is a standard
-system call, documented in the Linux manual page for fcntl. Only one
-user can open the CA Device in O_RDWR mode. All other attempts to open
-the device in this mode will fail, and an error code will be returned.
+DVB CA open()
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int open(const char *deviceName, int flags)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -69,11 +58,26 @@ Arguments
- (blocking mode is the default)
-Return Value
+DESCRIPTION
+-----------
+
+This system call opens a named ca device (e.g. /dev/ost/ca) for
+subsequent use.
+
+When an open() call has succeeded, the device will be ready for use. The
+significance of blocking or non-blocking mode is described in the
+documentation for functions where there is a difference. It does not
+affect the semantics of the open() call itself. A device opened in
+blocking mode can later be put into non-blocking mode (and vice versa)
+using the F_SETFL command of the fcntl system call. This is a standard
+system call, documented in the Linux manual page for fcntl. Only one
+user can open the CA Device in O_RDWR mode. All other attempts to open
+the device in this mode will fail, and an error code will be returned.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -102,6 +106,3 @@ Return Value
- ``EINVAL``
- Invalid argument.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-get-cap.rst b/Documentation/linux_tv/media/dvb/ca-get-cap.rst
index 9155e0b445ff..b026d4769730 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-cap.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-cap.rst
@@ -2,23 +2,23 @@
.. _CA_GET_CAP:
+==========
CA_GET_CAP
==========
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_GET_CAP
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
index cf5e3b1d8358..446afe89af82 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
@@ -2,23 +2,23 @@
.. _CA_GET_DESCR_INFO:
+=================
CA_GET_DESCR_INFO
=================
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_GET_DESCR_INFO
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-get-msg.rst b/Documentation/linux_tv/media/dvb/ca-get-msg.rst
index 994d73a59992..44c944a700c0 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-msg.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-msg.rst
@@ -2,23 +2,23 @@
.. _CA_GET_MSG:
+==========
CA_GET_MSG
==========
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_GET_MSG
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
index 8c123aaf5538..e1e580341dad 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
@@ -2,23 +2,23 @@
.. _CA_GET_SLOT_INFO:
+================
CA_GET_SLOT_INFO
================
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_GET_SLOT_INFO
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-reset.rst b/Documentation/linux_tv/media/dvb/ca-reset.rst
index 4fa2597ea983..ff58c62fb0a5 100644
--- a/Documentation/linux_tv/media/dvb/ca-reset.rst
+++ b/Documentation/linux_tv/media/dvb/ca-reset.rst
@@ -2,23 +2,23 @@
.. _CA_RESET:
+========
CA_RESET
========
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_RESET
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_RESET)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -38,11 +38,15 @@ Arguments
- Equals CA_RESET for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-send-msg.rst b/Documentation/linux_tv/media/dvb/ca-send-msg.rst
index cb9249561d8a..9d9b8d2520c1 100644
--- a/Documentation/linux_tv/media/dvb/ca-send-msg.rst
+++ b/Documentation/linux_tv/media/dvb/ca-send-msg.rst
@@ -2,23 +2,23 @@
.. _CA_SEND_MSG:
+===========
CA_SEND_MSG
===========
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_SEND_MSG
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-set-descr.rst b/Documentation/linux_tv/media/dvb/ca-set-descr.rst
index 5b56e414da24..e992dd52432d 100644
--- a/Documentation/linux_tv/media/dvb/ca-set-descr.rst
+++ b/Documentation/linux_tv/media/dvb/ca-set-descr.rst
@@ -2,23 +2,23 @@
.. _CA_SET_DESCR:
+============
CA_SET_DESCR
============
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_SET_DESCR
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/ca-set-pid.rst b/Documentation/linux_tv/media/dvb/ca-set-pid.rst
index 3d4b7e823c15..e7e3891fa65e 100644
--- a/Documentation/linux_tv/media/dvb/ca-set-pid.rst
+++ b/Documentation/linux_tv/media/dvb/ca-set-pid.rst
@@ -2,23 +2,23 @@
.. _CA_SET_PID:
+==========
CA_SET_PID
==========
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+CA_SET_PID
-Synopsis
+SYNOPSIS
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,7 +44,13 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
index d6fd0a351a51..36bca4f9317c 100644
--- a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
@@ -2,25 +2,23 @@
.. _DMX_ADD_PID:
+===========
DMX_ADD_PID
===========
-Description
------------
+NAME
+----
-This ioctl call allows to add multiple PIDs to a transport stream filter
-previously set up with DMX_SET_PES_FILTER and output equal to
-DMX_OUT_TSDEMUX_TAP.
+DMX_ADD_PID
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,11 +44,17 @@ Arguments
- PID number to be filtered.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call allows to add multiple PIDs to a transport stream filter
+previously set up with DMX_SET_PES_FILTER and output equal to
+DMX_OUT_TSDEMUX_TAP.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-fclose.rst b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
index 079e944b8fc8..7889d0b76f7d 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
@@ -2,24 +2,23 @@
.. _dmx_fclose:
+=================
DVB demux close()
=================
-Description
------------
+NAME
+----
-This system call deactivates and deallocates a filter that was
-previously allocated via the open() call.
+DVB demux close()
-Synopsis
+SYNOPSIS
--------
.. c:function:: int close(int fd)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -33,11 +32,16 @@ Arguments
- File descriptor returned by a previous call to open().
-Return Value
+DESCRIPTION
+-----------
+
+This system call deactivates and deallocates a filter that was
+previously allocated via the open() call.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -48,6 +52,3 @@ Return Value
- ``EBADF``
- fd is not a valid open file descriptor.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-fopen.rst b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
index 9d6d84d7b608..1e1dbc57c64d 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
@@ -2,10 +2,58 @@
.. _dmx_fopen:
+================
DVB demux open()
================
-Description
+NAME
+----
+
+DVB demux open()
+
+SYNOPSIS
+--------
+
+.. c:function:: int open(const char *deviceName, int flags)
+
+
+ARGUMENTS
+---------
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - const char \*deviceName
+
+ - Name of demux device.
+
+ - .. row 2
+
+ - int flags
+
+ - A bit-wise OR of the following flags:
+
+ - .. row 3
+
+ -
+ - O_RDWR read/write access
+
+ - .. row 4
+
+ -
+ - O_NONBLOCK open in non-blocking mode
+
+ - .. row 5
+
+ -
+ - (blocking mode is the default)
+
+
+DESCRIPTION
-----------
This system call, used with a device name of /dev/dvb/adapter0/demux0,
@@ -25,54 +73,10 @@ affect the semantics of the open() call itself. A device opened in
blocking mode can later be put into non-blocking mode (and vice versa)
using the F_SETFL command of the fcntl system call.
-Synopsis
---------
-.. c:function:: int open(const char *deviceName, int flags)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - const char \*deviceName
-
- - Name of demux device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDWR read/write access
-
- - .. row 4
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 5
-
- -
- - (blocking mode is the default)
-
-
-Return Value
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -101,6 +105,3 @@ Return Value
- ``ENOMEM``
- The driver failed to allocate enough memory.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-fread.rst b/Documentation/linux_tv/media/dvb/dmx-fread.rst
index 66811dbe6dac..55d9bc7f424d 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fread.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fread.rst
@@ -2,26 +2,23 @@
.. _dmx_fread:
+================
DVB demux read()
================
-Description
------------
+NAME
+----
-This system call returns filtered data, which might be section or PES
-data. The filtered data is transferred from the driver’s internal
-circular buffer to buf. The maximum amount of data to be transferred is
-implied by count.
+DVB demux read()
-Synopsis
+SYNOPSIS
--------
.. c:function:: size_t read(int fd, void *buf, size_t count)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -47,11 +44,18 @@ Arguments
- Size of buf.
-Return Value
+DESCRIPTION
+-----------
+
+This system call returns filtered data, which might be section or PES
+data. The filtered data is transferred from the driver’s internal
+circular buffer to buf. The maximum amount of data to be transferred is
+implied by count.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -101,6 +105,3 @@ Return Value
- The driver failed to write to the callers buffer due to an invalid
\*buf pointer.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
index 57aef82c77b2..f39743684966 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
@@ -2,28 +2,23 @@
.. _dmx_fwrite:
+=================
DVB demux write()
=================
-Description
------------
+NAME
+----
-This system call is only provided by the logical device
-/dev/dvb/adapter0/dvr0, associated with the physical demux device that
-provides the actual DVR functionality. It is used for replay of a
-digitally recorded Transport Stream. Matching filters have to be defined
-in the corresponding physical demux device, /dev/dvb/adapter0/demux0.
-The amount of data to be transferred is implied by count.
+DVB demux write()
-Synopsis
+SYNOPSIS
--------
.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -49,11 +44,20 @@ Arguments
- Size of buf.
-Return Value
+DESCRIPTION
+-----------
+
+This system call is only provided by the logical device
+/dev/dvb/adapter0/dvr0, associated with the physical demux device that
+provides the actual DVR functionality. It is used for replay of a
+digitally recorded Transport Stream. Matching filters have to be defined
+in the corresponding physical demux device, /dev/dvb/adapter0/demux0.
+The amount of data to be transferred is implied by count.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -82,6 +86,3 @@ Return Value
- ``EBADF``
- fd is not a valid open file descriptor.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
index 56bba7b3fc6c..8c8ae48a93da 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
@@ -2,23 +2,23 @@
.. _DMX_GET_CAPS:
+============
DMX_GET_CAPS
============
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+DMX_GET_CAPS
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-event.rst b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
index 8664d43f4334..ab2ab2ed3bed 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
@@ -2,27 +2,23 @@
.. _DMX_GET_EVENT:
+=============
DMX_GET_EVENT
=============
-Description
------------
+NAME
+----
-This ioctl call returns an event if available. If an event is not
-available, the behavior depends on whether the device is in blocking or
-non-blocking mode. In the latter case, the call fails immediately with
-errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
-event becomes available.
+DMX_GET_EVENT
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -48,7 +44,17 @@ Arguments
- Pointer to the location where the event is to be stored.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call returns an event if available. If an event is not
+available, the behavior depends on whether the device is in blocking or
+non-blocking mode. In the latter case, the call fails immediately with
+errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
+event becomes available.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -67,6 +73,3 @@ appropriately. The generic error codes are described at the
- ``EWOULDBLOCK``
- There is no event pending, and the device is in non-blocking mode.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
index 39d6ae6db620..cf0d8a6463fb 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
@@ -2,23 +2,23 @@
.. _DMX_GET_PES_PIDS:
+================
DMX_GET_PES_PIDS
================
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+DMX_GET_PES_PIDS
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
index 6081d959b4ad..35dd691dee09 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
@@ -2,28 +2,23 @@
.. _DMX_GET_STC:
+===========
DMX_GET_STC
===========
-Description
------------
+NAME
+----
-This ioctl call returns the current value of the system time counter
-(which is driven by a PES filter of type DMX_PES_PCR). Some hardware
-supports more than one STC, so you must specify which one by setting the
-num field of stc before the ioctl (range 0...n). The result is returned
-in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
-the real 90kHz STC value is stc->stc / stc->base .
+DMX_GET_STC
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -49,7 +44,18 @@ Arguments
- Pointer to the location where the stc is to be stored.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call returns the current value of the system time counter
+(which is driven by a PES filter of type DMX_PES_PCR). Some hardware
+supports more than one STC, so you must specify which one by setting the
+num field of stc before the ioctl (range 0...n). The result is returned
+in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
+the real 90kHz STC value is stc->stc / stc->base .
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -68,6 +74,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- Invalid stc number.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
index 9e38eb8db6f8..859e1a14de54 100644
--- a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
@@ -2,26 +2,23 @@
.. _DMX_REMOVE_PID:
+==============
DMX_REMOVE_PID
==============
-Description
------------
+NAME
+----
-This ioctl call allows to remove a PID when multiple PIDs are set on a
-transport stream filter, e. g. a filter previously set up with output
-equal to DMX_OUT_TSDEMUX_TAP, created via either
-DMX_SET_PES_FILTER or DMX_ADD_PID.
+DMX_REMOVE_PID
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -47,7 +44,16 @@ Arguments
- PID of the PES filter to be removed.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call allows to remove a PID when multiple PIDs are set on a
+transport stream filter, e. g. a filter previously set up with output
+equal to DMX_OUT_TSDEMUX_TAP, created via either
+DMX_SET_PES_FILTER or DMX_ADD_PID.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
index a5074a6ac48e..cf6b32f4e361 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
@@ -2,26 +2,23 @@
.. _DMX_SET_BUFFER_SIZE:
+===================
DMX_SET_BUFFER_SIZE
===================
-Description
------------
+NAME
+----
-This ioctl call is used to set the size of the circular buffer used for
-filtered data. The default size is two maximum sized sections, i.e. if
-this function is not called a buffer size of 2 \* 4096 bytes will be
-used.
+DMX_SET_BUFFER_SIZE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -47,11 +44,18 @@ Arguments
- Size of circular buffer.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call is used to set the size of the circular buffer used for
+filtered data. The default size is two maximum sized sections, i.e. if
+this function is not called a buffer size of 2 \* 4096 bytes will be
+used.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
index 548af600d635..0aad102f3151 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
@@ -2,32 +2,23 @@
.. _DMX_SET_FILTER:
+==============
DMX_SET_FILTER
==============
-Description
------------
+NAME
+----
-This ioctl call sets up a filter according to the filter and mask
-parameters provided. A timeout may be defined stating number of seconds
-to wait for a section to be loaded. A value of 0 means that no timeout
-should be applied. Finally there is a flag field where it is possible to
-state whether a section should be CRC-checked, whether the filter should
-be a ”one-shot” filter, i.e. if the filtering operation should be
-stopped after the first section is received, and whether the filtering
-operation should be started immediately (without waiting for a
-DMX_START ioctl call). If a filter was previously set-up, this filter
-will be canceled, and the receive buffer will be flushed.
+DMX_SET_FILTER
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -53,11 +44,24 @@ Arguments
- Pointer to structure containing filter parameters.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call sets up a filter according to the filter and mask
+parameters provided. A timeout may be defined stating number of seconds
+to wait for a section to be loaded. A value of 0 means that no timeout
+should be applied. Finally there is a flag field where it is possible to
+state whether a section should be CRC-checked, whether the filter should
+be a ”one-shot” filter, i.e. if the filtering operation should be
+stopped after the first section is received, and whether the filtering
+operation should be started immediately (without waiting for a
+DMX_START ioctl call). If a filter was previously set-up, this filter
+will be canceled, and the receive buffer will be flushed.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
index 7d9b6dabc772..3dccd7cd0a64 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
@@ -2,26 +2,23 @@
.. _DMX_SET_PES_FILTER:
+==================
DMX_SET_PES_FILTER
==================
-Description
------------
+NAME
+----
-This ioctl call sets up a PES filter according to the parameters
-provided. By a PES filter is meant a filter that is based just on the
-packet identifier (PID), i.e. no PES header or payload filtering
-capability is supported.
+DMX_SET_PES_FILTER
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -47,7 +44,16 @@ Arguments
- Pointer to structure containing filter parameters.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call sets up a PES filter according to the parameters
+provided. By a PES filter is meant a filter that is based just on the
+packet identifier (PID), i.e. no PES header or payload filtering
+capability is supported.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -69,6 +75,3 @@ appropriately. The generic error codes are described at the
There are active filters filtering data from another input source.
Make sure that these filters are stopped before starting this
filter.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-source.rst b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
index e97b1c962ed6..13045327857f 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-source.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
@@ -2,23 +2,23 @@
.. _DMX_SET_SOURCE:
+==============
DMX_SET_SOURCE
==============
-Description
------------
+NAME
+----
-This ioctl is undocumented. Documentation is welcome.
+DMX_SET_SOURCE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Undocumented.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is undocumented. Documentation is welcome.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-start.rst b/Documentation/linux_tv/media/dvb/dmx-start.rst
index dd446da18f97..c62e2ad17a6a 100644
--- a/Documentation/linux_tv/media/dvb/dmx-start.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-start.rst
@@ -2,24 +2,23 @@
.. _DMX_START:
+=========
DMX_START
=========
-Description
------------
+NAME
+----
-This ioctl call is used to start the actual filtering operation defined
-via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
+DMX_START
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl( int fd, int request = DMX_START)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -39,7 +38,14 @@ Arguments
- Equals DMX_START for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call is used to start the actual filtering operation defined
+via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -68,6 +74,3 @@ appropriately. The generic error codes are described at the
There are active filters filtering data from another input source.
Make sure that these filters are stopped before starting this
filter.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/dmx-stop.rst b/Documentation/linux_tv/media/dvb/dmx-stop.rst
index 150c9f79b55f..ff9df400f71f 100644
--- a/Documentation/linux_tv/media/dvb/dmx-stop.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-stop.rst
@@ -2,25 +2,23 @@
.. _DMX_STOP:
+========
DMX_STOP
========
-Description
------------
+NAME
+----
-This ioctl call is used to stop the actual filtering operation defined
-via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and
-started via the DMX_START command.
+DMX_STOP
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl( int fd, int request = DMX_STOP)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -40,11 +38,17 @@ Arguments
- Equals DMX_STOP for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call is used to stop the actual filtering operation defined
+via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and
+started via the DMX_START command.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
index 67e53787cc1e..60241c6e68a8 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
@@ -6,17 +6,18 @@
ioctl FE_DISEQC_RECV_SLAVE_REPLY
********************************
-*man FE_DISEQC_RECV_SLAVE_REPLY(2)*
+NAME
+====
-Receives reply from a DiSEqC 2.0 command
+FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -30,12 +31,14 @@ Arguments
:ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
-Description
+DESCRIPTION
===========
Receives reply from a DiSEqC 2.0 command.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
index 2c64eab598b8..236c25c9f7bd 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
@@ -6,18 +6,18 @@
ioctl FE_DISEQC_RESET_OVERLOAD
******************************
-*man FE_DISEQC_RESET_OVERLOAD(2)*
+NAME
+====
-Restores the power to the antenna subsystem, if it was powered off due
-to power overload.
+FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it was powered off due - to power overload.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, NULL )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -27,7 +27,7 @@ Arguments
FE_DISEQC_RESET_OVERLOAD
-Description
+DESCRIPTION
===========
If the bus has been automatically powered off due to power overload,
@@ -35,7 +35,9 @@ this ioctl call restores the power to the bus. The call requires
read/write access to the device. This call has no effect if the device
is manually powered off. Not all DVB adapters support this ioctl.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
index 35de0278a064..dea9cdff0469 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
@@ -6,17 +6,18 @@
ioctl FE_DISEQC_SEND_BURST
**************************
-*man FE_DISEQC_SEND_BURST(2)*
+NAME
+====
-Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
+FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
-
-Synopsis
+SYNOPSIS
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +30,7 @@ Arguments
pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>`
-Description
+DESCRIPTION
===========
This ioctl is used to set the generation of a 22kHz tone burst for mini
@@ -39,7 +40,9 @@ read/write permissions.
It provides support for what's specified at
`Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
index 04c6cc8ae070..519e91bd47fd 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
@@ -6,17 +6,18 @@
ioctl FE_DISEQC_SEND_MASTER_CMD
*******************************
-*man FE_DISEQC_SEND_MASTER_CMD(2)*
+NAME
+====
-Sends a DiSEqC command
+FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -30,12 +31,14 @@ Arguments
:ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>`
-Description
+DESCRIPTION
===========
Sends a DiSEqC command to the antenna subsystem.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
index 669dbd6e79b8..27f49823e67d 100644
--- a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
@@ -6,18 +6,18 @@
ioctl FE_ENABLE_HIGH_LNB_VOLTAGE
********************************
-*man FE_ENABLE_HIGH_LNB_VOLTAGE(2)*
+NAME
+====
-Select output DC level between normal LNBf voltages or higher LNBf
-voltages.
+FE_ENABLE_HIGH_LNB_VOLTAGE - Select output DC level between normal LNBf voltages or higher LNBf - voltages.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int high )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -35,14 +35,16 @@ Arguments
to compensate for long antenna cables.
-Description
+DESCRIPTION
===========
Select output DC level between normal LNBf voltages or higher LNBf
voltages between 0 (normal) or a value grater than 0 for higher
voltages.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-get-info.rst b/Documentation/linux_tv/media/dvb/fe-get-info.rst
index 97743d9418ac..d97218805851 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-info.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-info.rst
@@ -6,18 +6,18 @@
ioctl FE_GET_INFO
*****************
-*man FE_GET_INFO(2)*
+NAME
+====
-Query DVB frontend capabilities and returns information about the
-front-end. This call only requires read-only access to the device
+FE_GET_INFO - Query DVB frontend capabilities and returns information about the - front-end. This call only requires read-only access to the device
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
:ref:`dvb_frontend_info <dvb-frontend-info>`
-Description
+DESCRIPTION
===========
All DVB frontend devices support the ``FE_GET_INFO`` ioctl. It is used
@@ -41,7 +41,9 @@ takes a pointer to dvb_frontend_info which is filled by the driver.
When the driver is not compatible with this specification the ioctl
returns an error.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-get-property.rst b/Documentation/linux_tv/media/dvb/fe-get-property.rst
index 0edc9291fc70..c470105dcd15 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-property.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-property.rst
@@ -6,19 +6,18 @@
ioctl FE_SET_PROPERTY, FE_GET_PROPERTY
**************************************
-*man FE_SET_PROPERTY(2)*
+NAME
+====
-FE_GET_PROPERTY
-FE_SET_PROPERTY sets one or more frontend properties.
-FE_GET_PROPERTY returns one or more frontend properties.
+FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend properties. - FE_GET_PROPERTY returns one or more frontend properties.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +30,7 @@ Arguments
pointer to struct :ref:`dtv_properties <dtv-properties>`
-Description
+DESCRIPTION
===========
All DVB frontend devices support the ``FE_SET_PROPERTY`` and
@@ -59,7 +58,9 @@ depends on the delivery system and on the device:
- This call only requires read-only access to the device.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-read-status.rst b/Documentation/linux_tv/media/dvb/fe-read-status.rst
index 56347eed3703..ac6f23869530 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-status.rst
@@ -6,18 +6,18 @@
ioctl FE_READ_STATUS
********************
-*man FE_READ_STATUS(2)*
+NAME
+====
-Returns status information about the front-end. This call only requires
-read-only access to the device
+FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int *status )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
:ref:`fe_status <fe-status>`.
-Description
+DESCRIPTION
===========
All DVB frontend devices support the ``FE_READ_STATUS`` ioctl. It is
@@ -43,7 +43,9 @@ NOTE: the size of status is actually sizeof(enum fe_status), with
varies according with the architecture. This needs to be fixed in the
future.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
index aeecb947fa70..1db22c426b8c 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
@@ -6,17 +6,18 @@
ioctl FE_SET_FRONTEND_TUNE_MODE
*******************************
-*man FE_SET_FRONTEND_TUNE_MODE(2)*
+NAME
+====
-Allow setting tuner mode flags to the frontend.
+FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int flags )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -38,13 +39,15 @@ Arguments
device is reopened read-write.
-Description
+DESCRIPTION
===========
Allow setting tuner mode flags to the frontend, between 0 (normal) or
FE_TUNE_MODE_ONESHOT mode
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-set-tone.rst b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
index 5e80ee9988b0..afe8b750fca6 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-tone.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
@@ -6,17 +6,18 @@
ioctl FE_SET_TONE
*****************
-*man FE_SET_TONE(2)*
+NAME
+====
-Sets/resets the generation of the continuous 22kHz tone.
+FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
-
-Synopsis
+SYNOPSIS
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_tone_mode *tone )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +30,7 @@ Arguments
pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>`
-Description
+DESCRIPTION
===========
This ioctl is used to set the generation of the continuous 22kHz tone.
@@ -45,7 +46,9 @@ a tone may interfere on other devices, as they may lose the capability
of selecting the band. So, it is recommended that applications would
change to SEC_TONE_OFF when the device is not used.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
index 63c5f401e808..4fd30ee53f5b 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
@@ -6,17 +6,18 @@
ioctl FE_SET_VOLTAGE
********************
-*man FE_SET_VOLTAGE(2)*
+NAME
+====
-Allow setting the DC level sent to the antenna subsystem.
+FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem.
-
-Synopsis
+SYNOPSIS
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -32,7 +33,7 @@ Arguments
:ref:`fe_sec_voltage <fe-sec-voltage>`.
-Description
+DESCRIPTION
===========
This ioctl allows to set the DC voltage level sent through the antenna
@@ -52,7 +53,9 @@ capability of setting polarization or IF. So, on those cases, setting
the voltage to SEC_VOLTAGE_OFF while the device is not is used is
recommended.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_close.rst b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
index 8ca7f723ffc3..7946673d071a 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_close.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
@@ -6,12 +6,12 @@
DVB frontend close()
********************
-*man fe-close(2)*
+NAME
+====
-Close a frontend device
+fe-close - Close a frontend device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,14 +21,15 @@ Synopsis
.. cpp:function:: int close( int fd )
-Arguments
+
+ARGUMENTS
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-Description
+DESCRIPTION
===========
This system call closes a previously opened front-end device. After
@@ -36,7 +37,7 @@ closing a front-end device, its corresponding hardware might be powered
down automatically.
-Return Value
+RETURN VALUE
============
The function returns 0 on success, -1 on failure and the ``errno`` is
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_open.rst b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
index d28c64514433..97ca34b94d05 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_open.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
@@ -6,12 +6,12 @@
DVB frontend open()
*******************
-*man fe-open(2)*
+NAME
+====
-Open a frontend device
+fe-open - Open a frontend device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: int open( const char *device_name, int flags )
-Arguments
+
+ARGUMENTS
=========
``device_name``
@@ -43,7 +44,7 @@ Arguments
Other flags have no effect.
-Description
+DESCRIPTION
===========
This system call opens a named frontend device
@@ -69,7 +70,7 @@ powered up, and that other front-ends may have been powered down to make
that possible.
-Return Value
+RETURN VALUE
============
On success :ref:`open() <frontend_f_open>` returns the new file descriptor.
diff --git a/Documentation/linux_tv/media/dvb/net-add-if.rst b/Documentation/linux_tv/media/dvb/net-add-if.rst
index da0e7870c5d9..dc9735d871ee 100644
--- a/Documentation/linux_tv/media/dvb/net-add-if.rst
+++ b/Documentation/linux_tv/media/dvb/net-add-if.rst
@@ -6,17 +6,18 @@
ioctl NET_ADD_IF
****************
-*man NET_ADD_IF(2)*
+NAME
+====
-Creates a new network interface for a given Packet ID.
+NET_ADD_IF - Creates a new network interface for a given Packet ID.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +30,7 @@ Arguments
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-Description
+DESCRIPTION
===========
The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
@@ -80,7 +81,9 @@ struct dvb_net_if description
``DVB_NET_FEEDTYPE_MPE`` for MPE encoding or
``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/net-get-if.rst b/Documentation/linux_tv/media/dvb/net-get-if.rst
index 4581763b920e..16dfe78eb77f 100644
--- a/Documentation/linux_tv/media/dvb/net-get-if.rst
+++ b/Documentation/linux_tv/media/dvb/net-get-if.rst
@@ -1,24 +1,23 @@
.. -*- coding: utf-8; mode: rst -*-
-
.. _NET_GET_IF:
****************
ioctl NET_GET_IF
****************
-*man NET_GET_IF(2)*
+NAME
+====
-Read the configuration data of an interface created via
-:ref:`NET_ADD_IF <net>`.
+NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +30,7 @@ Arguments
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-Description
+DESCRIPTION
===========
The NET_GET_IF ioctl uses the interface number given by the struct
@@ -41,7 +40,9 @@ encapsulation type used on such interface. If the interface was not
created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
the ``errno`` with ``EINVAL`` error code.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/net-remove-if.rst b/Documentation/linux_tv/media/dvb/net-remove-if.rst
index 15a5d49f7a80..c4177833ecf6 100644
--- a/Documentation/linux_tv/media/dvb/net-remove-if.rst
+++ b/Documentation/linux_tv/media/dvb/net-remove-if.rst
@@ -6,17 +6,18 @@
ioctl NET_REMOVE_IF
*******************
-*man NET_REMOVE_IF(2)*
+NAME
+====
-Removes a network interface.
+NET_REMOVE_IF - Removes a network interface.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, int ifnum )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,13 +30,15 @@ Arguments
number of the interface to be removed
-Description
+DESCRIPTION
===========
The NET_REMOVE_IF ioctl deletes an interface previously created via
:ref:`NET_ADD_IF <net>`.
+
RETURN VALUE
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
index 65efef3cc0fc..e6d2825f4c9b 100644
--- a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
+++ b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
@@ -2,24 +2,23 @@
.. _VIDEO_CLEAR_BUFFER:
+==================
VIDEO_CLEAR_BUFFER
==================
-Description
------------
+NAME
+----
-This ioctl call clears all video buffers in the driver and in the
-decoder hardware.
+VIDEO_CLEAR_BUFFER
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -39,11 +38,16 @@ Arguments
- Equals VIDEO_CLEAR_BUFFER for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call clears all video buffers in the driver and in the
+decoder hardware.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-command.rst b/Documentation/linux_tv/media/dvb/video-command.rst
index 855a646a0f93..1743f40145ff 100644
--- a/Documentation/linux_tv/media/dvb/video-command.rst
+++ b/Documentation/linux_tv/media/dvb/video-command.rst
@@ -2,30 +2,23 @@
.. _VIDEO_COMMAND:
+=============
VIDEO_COMMAND
=============
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the
-:ref:`VIDIOC_DECODER_CMD` ioctl.
+NAME
+----
-This ioctl commands the decoder. The ``video_command`` struct is a
-subset of the ``v4l2_decoder_cmd`` struct, so refer to the
-:ref:`VIDIOC_DECODER_CMD` documentation for
-more information.
+VIDEO_COMMAND
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -51,11 +44,22 @@ Arguments
- Commands the decoder.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the
+:ref:`VIDIOC_DECODER_CMD` ioctl.
+
+This ioctl commands the decoder. The ``video_command`` struct is a
+subset of the ``v4l2_decoder_cmd`` struct, so refer to the
+:ref:`VIDIOC_DECODER_CMD` documentation for
+more information.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-continue.rst b/Documentation/linux_tv/media/dvb/video-continue.rst
index 9d0f70b7c340..453a87dfb40d 100644
--- a/Documentation/linux_tv/media/dvb/video-continue.rst
+++ b/Documentation/linux_tv/media/dvb/video-continue.rst
@@ -2,27 +2,23 @@
.. _VIDEO_CONTINUE:
+==============
VIDEO_CONTINUE
==============
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+NAME
+----
-This ioctl call restarts decoding and playing processes of the video
-stream which was played before a call to VIDEO_FREEZE was made.
+VIDEO_CONTINUE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -42,11 +38,19 @@ Arguments
- Equals VIDEO_CONTINUE for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call restarts decoding and playing processes of the video
+stream which was played before a call to VIDEO_FREEZE was made.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-fast-forward.rst b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
index 3cf7d2d9d817..586a23bb5cfd 100644
--- a/Documentation/linux_tv/media/dvb/video-fast-forward.rst
+++ b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
@@ -2,25 +2,23 @@
.. _VIDEO_FAST_FORWARD:
+==================
VIDEO_FAST_FORWARD
==================
-Description
------------
+NAME
+----
-This ioctl call asks the Video Device to skip decoding of N number of
-I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
-selected.
+VIDEO_FAST_FORWARD
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,7 +44,15 @@ Arguments
- The number of frames to skip.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Video Device to skip decoding of N number of
+I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
+selected.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -65,6 +71,3 @@ appropriately. The generic error codes are described at the
- ``EPERM``
- Mode VIDEO_SOURCE_MEMORY not selected.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-fclose.rst b/Documentation/linux_tv/media/dvb/video-fclose.rst
index c9fc6560cb43..e98673768d2b 100644
--- a/Documentation/linux_tv/media/dvb/video-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/video-fclose.rst
@@ -2,23 +2,23 @@
.. _video_fclose:
+=================
dvb video close()
=================
-Description
------------
+NAME
+----
-This system call closes a previously opened video device.
+dvb video close()
-Synopsis
+SYNOPSIS
--------
.. c:function:: int close(int fd)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -32,11 +32,15 @@ Arguments
- File descriptor returned by a previous call to open().
-Return Value
+DESCRIPTION
+-----------
+
+This system call closes a previously opened video device.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -47,6 +51,3 @@ Return Value
- ``EBADF``
- fd is not a valid open file descriptor.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-fopen.rst b/Documentation/linux_tv/media/dvb/video-fopen.rst
index 9de94d4f69dd..3c30fef2aab6 100644
--- a/Documentation/linux_tv/media/dvb/video-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/video-fopen.rst
@@ -2,10 +2,63 @@
.. _video_fopen:
+================
dvb video open()
================
-Description
+NAME
+----
+
+dvb video open()
+
+SYNOPSIS
+--------
+
+.. c:function:: int open(const char *deviceName, int flags)
+
+
+ARGUMENTS
+---------
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - const char \*deviceName
+
+ - Name of specific video device.
+
+ - .. row 2
+
+ - int flags
+
+ - A bit-wise OR of the following flags:
+
+ - .. row 3
+
+ -
+ - O_RDONLY read-only access
+
+ - .. row 4
+
+ -
+ - O_RDWR read/write access
+
+ - .. row 5
+
+ -
+ - O_NONBLOCK open in non-blocking mode
+
+ - .. row 6
+
+ -
+ - (blocking mode is the default)
+
+
+DESCRIPTION
-----------
This system call opens a named video device (e.g.
@@ -24,57 +77,10 @@ returned. If the Video Device is opened in O_RDONLY mode, the only
ioctl call that can be used is VIDEO_GET_STATUS. All other call will
return an error code.
-Synopsis
---------
-.. c:function:: int open(const char *deviceName, int flags)
-
-Arguments
-----------
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - const char \*deviceName
-
- - Name of specific video device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDONLY read-only access
-
- - .. row 4
-
- -
- - O_RDWR read/write access
-
- - .. row 5
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 6
-
- -
- - (blocking mode is the default)
-
-
-Return Value
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -103,6 +109,3 @@ Return Value
- ``EINVAL``
- Invalid argument.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-freeze.rst b/Documentation/linux_tv/media/dvb/video-freeze.rst
index d384e329b661..8fbc7835382c 100644
--- a/Documentation/linux_tv/media/dvb/video-freeze.rst
+++ b/Documentation/linux_tv/media/dvb/video-freeze.rst
@@ -2,31 +2,23 @@
.. _VIDEO_FREEZE:
+============
VIDEO_FREEZE
============
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+NAME
+----
-This ioctl call suspends the live video stream being played. Decoding
-and playing are frozen. It is then possible to restart the decoding and
-playing process of the video stream using the VIDEO_CONTINUE command.
-If VIDEO_SOURCE_MEMORY is selected in the ioctl call
-VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
-until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
+VIDEO_FREEZE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,11 +38,23 @@ Arguments
- Equals VIDEO_FREEZE for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call suspends the live video stream being played. Decoding
+and playing are frozen. It is then possible to restart the decoding and
+playing process of the video stream using the VIDEO_CONTINUE command.
+If VIDEO_SOURCE_MEMORY is selected in the ioctl call
+VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
+until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-fwrite.rst b/Documentation/linux_tv/media/dvb/video-fwrite.rst
index 398bbeaeaf8b..f56c89caef32 100644
--- a/Documentation/linux_tv/media/dvb/video-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/video-fwrite.rst
@@ -2,27 +2,23 @@
.. _video_fwrite:
+=================
dvb video write()
=================
-Description
------------
+NAME
+----
-This system call can only be used if VIDEO_SOURCE_MEMORY is selected
-in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in
-PES format, unless the capability allows other formats. If O_NONBLOCK
-is not specified the function will block until buffer space is
-available. The amount of data to be transferred is implied by count.
+dvb video write()
-Synopsis
+SYNOPSIS
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -48,11 +44,19 @@ Arguments
- Size of buf.
-Return Value
+DESCRIPTION
+-----------
+
+This system call can only be used if VIDEO_SOURCE_MEMORY is selected
+in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in
+PES format, unless the capability allows other formats. If O_NONBLOCK
+is not specified the function will block until buffer space is
+available. The amount of data to be transferred is implied by count.
+
+
+RETURN VALUE
------------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
@@ -75,6 +79,3 @@ Return Value
- ``EBADF``
- fd is not a valid open file descriptor.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
index 7b5dcc523a69..5666ae7f20c0 100644
--- a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
@@ -2,25 +2,23 @@
.. _VIDEO_GET_CAPABILITIES:
+======================
VIDEO_GET_CAPABILITIES
======================
-Description
------------
+NAME
+----
-This ioctl call asks the video device about its decoding capabilities.
-On success it returns and integer which has bits set according to the
-defines in section ??.
+VIDEO_GET_CAPABILITIES
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,11 +44,17 @@ Arguments
- Pointer to a location where to store the capability information.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the video device about its decoding capabilities.
+On success it returns and integer which has bits set according to the
+defines in section ??.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-event.rst b/Documentation/linux_tv/media/dvb/video-get-event.rst
index b958652cac7b..3240cd6da6f6 100644
--- a/Documentation/linux_tv/media/dvb/video-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-event.rst
@@ -2,10 +2,49 @@
.. _VIDEO_GET_EVENT:
+===============
VIDEO_GET_EVENT
===============
-Description
+NAME
+----
+
+VIDEO_GET_EVENT
+
+SYNOPSIS
+--------
+
+.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
+
+
+ARGUMENTS
+---------
+
+.. flat-table::
+ :header-rows: 0
+ :stub-columns: 0
+
+
+ - .. row 1
+
+ - int fd
+
+ - File descriptor returned by a previous call to open().
+
+ - .. row 2
+
+ - int request
+
+ - Equals VIDEO_GET_EVENT for this command.
+
+ - .. row 3
+
+ - struct video_event \*ev
+
+ - Points to the location where the event, if any, is to be stored.
+
+
+DESCRIPTION
-----------
This ioctl is for DVB devices only. To get events from a V4L2 decoder
@@ -22,41 +61,8 @@ included in the exceptfds argument, and for poll(), POLLPRI should be
specified as the wake-up condition. Read-only permissions are sufficient
for this ioctl call.
-Synopsis
---------
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
-
-Arguments
-----------
-
-
-
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - int request
-
- - Equals VIDEO_GET_EVENT for this command.
-
- - .. row 3
-
- - struct video_event \*ev
-
- - Points to the location where the event, if any, is to be stored.
-
-
-Return Value
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -81,6 +87,3 @@ appropriately. The generic error codes are described at the
- ``EOVERFLOW``
- Overflow in event queue - one or more events were lost.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
index c7c140f2467a..97ec05810154 100644
--- a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
@@ -2,28 +2,23 @@
.. _VIDEO_GET_FRAME_COUNT:
+=====================
VIDEO_GET_FRAME_COUNT
=====================
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_FRAME``
-control.
+NAME
+----
-This ioctl call asks the Video Device to return the number of displayed
-frames since the decoder was started.
+VIDEO_GET_FRAME_COUNT
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -50,11 +45,20 @@ Arguments
started.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_FRAME``
+control.
+
+This ioctl call asks the Video Device to return the number of displayed
+frames since the decoder was started.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
index bfd09385cb31..62a85be537ab 100644
--- a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
@@ -2,23 +2,23 @@
.. _VIDEO_GET_FRAME_RATE:
+====================
VIDEO_GET_FRAME_RATE
====================
-Description
------------
+NAME
+----
-This ioctl call asks the Video Device to return the current framerate.
+VIDEO_GET_FRAME_RATE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Returns the framerate in number of frames per 1000 seconds.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Video Device to return the current framerate.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-navi.rst b/Documentation/linux_tv/media/dvb/video-get-navi.rst
index 62451fc03924..95dea513bc48 100644
--- a/Documentation/linux_tv/media/dvb/video-get-navi.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-navi.rst
@@ -2,25 +2,23 @@
.. _VIDEO_GET_NAVI:
+==============
VIDEO_GET_NAVI
==============
-Description
------------
+NAME
+----
-This ioctl returns navigational information from the DVD stream. This is
-especially needed if an encoded stream has to be decoded by the
-hardware.
+VIDEO_GET_NAVI
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,7 +44,15 @@ Arguments
- PCI or DSI pack (private stream 2) according to section ??.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl returns navigational information from the DVD stream. This is
+especially needed if an encoded stream has to be decoded by the
+hardware.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -65,6 +71,3 @@ appropriately. The generic error codes are described at the
- ``EFAULT``
- driver is not able to return navigational information
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-pts.rst b/Documentation/linux_tv/media/dvb/video-get-pts.rst
index 67b929753963..f56e02a1f447 100644
--- a/Documentation/linux_tv/media/dvb/video-get-pts.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-pts.rst
@@ -2,28 +2,23 @@
.. _VIDEO_GET_PTS:
+=============
VIDEO_GET_PTS
=============
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS``
-control.
+NAME
+----
-This ioctl call asks the Video Device to return the current PTS
-timestamp.
+VIDEO_GET_PTS
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -54,11 +49,20 @@ Arguments
decoded frame or the last PTS extracted by the PES parser.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS``
+control.
+
+This ioctl call asks the Video Device to return the current PTS
+timestamp.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-size.rst b/Documentation/linux_tv/media/dvb/video-get-size.rst
index 0e16d91838ac..cbdf976223e5 100644
--- a/Documentation/linux_tv/media/dvb/video-get-size.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-size.rst
@@ -2,23 +2,23 @@
.. _VIDEO_GET_SIZE:
+==============
VIDEO_GET_SIZE
==============
-Description
------------
+NAME
+----
-This ioctl returns the size and aspect ratio.
+VIDEO_GET_SIZE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,11 +44,15 @@ Arguments
- Returns the size and aspect ratio.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl returns the size and aspect ratio.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-get-status.rst b/Documentation/linux_tv/media/dvb/video-get-status.rst
index fd9e591de5df..25344bf0ea7b 100644
--- a/Documentation/linux_tv/media/dvb/video-get-status.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-status.rst
@@ -2,24 +2,23 @@
.. _VIDEO_GET_STATUS:
+================
VIDEO_GET_STATUS
================
-Description
------------
+NAME
+----
-This ioctl call asks the Video Device to return the current status of
-the device.
+VIDEO_GET_STATUS
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,11 +44,16 @@ Arguments
- Returns the current status of the Video Device.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Video Device to return the current status of
+the device.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-play.rst b/Documentation/linux_tv/media/dvb/video-play.rst
index da328ed2b4a0..18252d9d2ce6 100644
--- a/Documentation/linux_tv/media/dvb/video-play.rst
+++ b/Documentation/linux_tv/media/dvb/video-play.rst
@@ -2,27 +2,23 @@
.. _VIDEO_PLAY:
+==========
VIDEO_PLAY
==========
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+NAME
+----
-This ioctl call asks the Video Device to start playing a video stream
-from the selected source.
+VIDEO_PLAY
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -42,11 +38,19 @@ Arguments
- Equals VIDEO_PLAY for this command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call asks the Video Device to start playing a video stream
+from the selected source.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-select-source.rst b/Documentation/linux_tv/media/dvb/video-select-source.rst
index 41fc728508c0..2e76af3d468b 100644
--- a/Documentation/linux_tv/media/dvb/video-select-source.rst
+++ b/Documentation/linux_tv/media/dvb/video-select-source.rst
@@ -2,29 +2,23 @@
.. _VIDEO_SELECT_SOURCE:
+===================
VIDEO_SELECT_SOURCE
===================
-Description
------------
-
-This ioctl is for DVB devices only. This ioctl was also supported by the
-V4L2 ivtv driver, but that has been replaced by the ivtv-specific
-``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
+NAME
+----
-This ioctl call informs the video device which source shall be used for
-the input data. The possible sources are demux or memory. If memory is
-selected, the data is fed to the video device through the write command.
+VIDEO_SELECT_SOURCE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -50,11 +44,21 @@ Arguments
- Indicates which source shall be used for the Video stream.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. This ioctl was also supported by the
+V4L2 ivtv driver, but that has been replaced by the ivtv-specific
+``IVTV_IOC_PASSTHROUGH_MODE`` ioctl.
+
+This ioctl call informs the video device which source shall be used for
+the input data. The possible sources are demux or memory. If memory is
+selected, the data is fed to the video device through the write command.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-attributes.rst b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
index 255efe0872d1..6de9378ce1c7 100644
--- a/Documentation/linux_tv/media/dvb/video-set-attributes.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
@@ -2,26 +2,23 @@
.. _VIDEO_SET_ATTRIBUTES:
+====================
VIDEO_SET_ATTRIBUTES
====================
-Description
------------
+NAME
+----
-This ioctl is intended for DVD playback and allows you to set certain
-information about the stream. Some hardware may not need this
-information, but the call also tells the hardware to prepare for DVD
-playback.
+VIDEO_SET_ATTRIBUTES
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -47,7 +44,16 @@ Arguments
- video attributes according to section ??.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is intended for DVD playback and allows you to set certain
+information about the stream. Some hardware may not need this
+information, but the call also tells the hardware to prepare for DVD
+playback.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-blank.rst b/Documentation/linux_tv/media/dvb/video-set-blank.rst
index 0ed2afdf4b72..62b46b8b2d02 100644
--- a/Documentation/linux_tv/media/dvb/video-set-blank.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-blank.rst
@@ -2,23 +2,23 @@
.. _VIDEO_SET_BLANK:
+===============
VIDEO_SET_BLANK
===============
-Description
------------
+NAME
+----
-This ioctl call asks the Video Device to blank out the picture.
+VIDEO_SET_BLANK
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -49,11 +49,15 @@ Arguments
- FALSE: Show last decoded frame.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Video Device to blank out the picture.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-display-format.rst b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
index af55cefbd3c0..7aec080638de 100644
--- a/Documentation/linux_tv/media/dvb/video-set-display-format.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
@@ -2,24 +2,23 @@
.. _VIDEO_SET_DISPLAY_FORMAT:
+========================
VIDEO_SET_DISPLAY_FORMAT
========================
-Description
------------
+NAME
+----
-This ioctl call asks the Video Device to select the video format to be
-applied by the MPEG chip on the video.
+VIDEO_SET_DISPLAY_FORMAT
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,11 +44,16 @@ Arguments
- Selects the video format to be used.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Video Device to select the video format to be
+applied by the MPEG chip on the video.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-format.rst b/Documentation/linux_tv/media/dvb/video-set-format.rst
index aea4d913c760..af126d2de8c3 100644
--- a/Documentation/linux_tv/media/dvb/video-set-format.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-format.rst
@@ -2,25 +2,23 @@
.. _VIDEO_SET_FORMAT:
+================
VIDEO_SET_FORMAT
================
-Description
------------
+NAME
+----
-This ioctl sets the screen format (aspect ratio) of the connected output
-device (TV) so that the output of the decoder can be adjusted
-accordingly.
+VIDEO_SET_FORMAT
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,7 +44,15 @@ Arguments
- video format of TV as defined in section ??.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl sets the screen format (aspect ratio) of the connected output
+device (TV) so that the output of the decoder can be adjusted
+accordingly.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -65,6 +71,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- format is not a valid video format.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-highlight.rst b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
index e92b7ac28f23..d8628d282740 100644
--- a/Documentation/linux_tv/media/dvb/video-set-highlight.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
@@ -2,24 +2,23 @@
.. _VIDEO_SET_HIGHLIGHT:
+===================
VIDEO_SET_HIGHLIGHT
===================
-Description
------------
+NAME
+----
-This ioctl sets the SPU highlight information for the menu access of a
-DVD.
+VIDEO_SET_HIGHLIGHT
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,11 +44,16 @@ Arguments
- SPU Highlight information according to section ??.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl sets the SPU highlight information for the menu access of a
+DVD.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-id.rst b/Documentation/linux_tv/media/dvb/video-set-id.rst
index 5a58405fba42..31ca41f8b6af 100644
--- a/Documentation/linux_tv/media/dvb/video-set-id.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-id.rst
@@ -2,24 +2,23 @@
.. _VIDEO_SET_ID:
+============
VIDEO_SET_ID
============
-Description
------------
+NAME
+----
-This ioctl selects which sub-stream is to be decoded if a program or
-system stream is sent to the video device.
+VIDEO_SET_ID
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -45,7 +44,14 @@ Arguments
- video sub-stream id
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl selects which sub-stream is to be decoded if a program or
+system stream is sent to the video device.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -64,6 +70,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- Invalid sub-stream id.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
index 3fb338ee7420..b3b727fec64b 100644
--- a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
@@ -2,23 +2,23 @@
.. _VIDEO_SET_SPU_PALETTE:
+=====================
VIDEO_SET_SPU_PALETTE
=====================
-Description
------------
+NAME
+----
-This ioctl sets the SPU color palette.
+VIDEO_SET_SPU_PALETTE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -44,7 +44,13 @@ Arguments
- SPU palette according to section ??.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl sets the SPU color palette.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -63,6 +69,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- input is not a valid palette or driver doesn’t handle SPU.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu.rst b/Documentation/linux_tv/media/dvb/video-set-spu.rst
index 863c6248fab9..d00d0b5272d7 100644
--- a/Documentation/linux_tv/media/dvb/video-set-spu.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-spu.rst
@@ -2,24 +2,23 @@
.. _VIDEO_SET_SPU:
+=============
VIDEO_SET_SPU
=============
-Description
------------
+NAME
+----
-This ioctl activates or deactivates SPU decoding in a DVD input stream.
-It can only be used, if the driver is able to handle a DVD stream.
+VIDEO_SET_SPU
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,7 +45,14 @@ Arguments
??.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl activates or deactivates SPU decoding in a DVD input stream.
+It can only be used, if the driver is able to handle a DVD stream.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -65,6 +71,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- input is not a valid spu setting or driver cannot handle SPU.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
index c412051cc073..6875ff8db77e 100644
--- a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
@@ -2,25 +2,23 @@
.. _VIDEO_SET_STREAMTYPE:
+====================
VIDEO_SET_STREAMTYPE
====================
-Description
------------
+NAME
+----
-This ioctl tells the driver which kind of stream to expect being written
-to it. If this call is not used the default of video PES is used. Some
-drivers might not support this call and always expect PES.
+VIDEO_SET_STREAMTYPE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,11 +44,17 @@ Arguments
- stream type
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl tells the driver which kind of stream to expect being written
+to it. If this call is not used the default of video PES is used. Some
+drivers might not support this call and always expect PES.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-set-system.rst b/Documentation/linux_tv/media/dvb/video-set-system.rst
index 70bff8a1c53a..7fcd1a1fb78b 100644
--- a/Documentation/linux_tv/media/dvb/video-set-system.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-system.rst
@@ -2,26 +2,23 @@
.. _VIDEO_SET_SYSTEM:
+================
VIDEO_SET_SYSTEM
================
-Description
------------
+NAME
+----
-This ioctl sets the television output format. The format (see section
-??) may vary from the color format of the displayed MPEG stream. If the
-hardware is not able to display the requested format the call will
-return an error.
+VIDEO_SET_SYSTEM
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -47,7 +44,16 @@ Arguments
- video system of TV output.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl sets the television output format. The format (see section
+??) may vary from the color format of the displayed MPEG stream. If the
+hardware is not able to display the requested format the call will
+return an error.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -66,6 +72,3 @@ appropriately. The generic error codes are described at the
- ``EINVAL``
- system is not a valid or supported video system.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-slowmotion.rst b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
index e04ad5776683..6472abb1e42d 100644
--- a/Documentation/linux_tv/media/dvb/video-slowmotion.rst
+++ b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
@@ -2,25 +2,23 @@
.. _VIDEO_SLOWMOTION:
+================
VIDEO_SLOWMOTION
================
-Description
------------
+NAME
+----
-This ioctl call asks the video device to repeat decoding frames N number
-of times. This call can only be used if VIDEO_SOURCE_MEMORY is
-selected.
+VIDEO_SLOWMOTION
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,7 +44,15 @@ Arguments
- The number of times to repeat each frame.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the video device to repeat decoding frames N number
+of times. This call can only be used if VIDEO_SOURCE_MEMORY is
+selected.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -65,6 +71,3 @@ appropriately. The generic error codes are described at the
- ``EPERM``
- Mode VIDEO_SOURCE_MEMORY not selected.
-
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-stillpicture.rst b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
index 94ae66c1d97b..93c9c30bcdd3 100644
--- a/Documentation/linux_tv/media/dvb/video-stillpicture.rst
+++ b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
@@ -2,25 +2,23 @@
.. _VIDEO_STILLPICTURE:
+==================
VIDEO_STILLPICTURE
==================
-Description
------------
+NAME
+----
-This ioctl call asks the Video Device to display a still picture
-(I-frame). The input data shall contain an I-frame. If the pointer is
-NULL, then the current displayed still picture is blanked.
+VIDEO_STILLPICTURE
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -46,11 +44,17 @@ Arguments
- Pointer to a location where an I-frame and size is stored.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl call asks the Video Device to display a still picture
+(I-frame). The input data shall contain an I-frame. If the pointer is
+NULL, then the current displayed still picture is blanked.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-stop.rst b/Documentation/linux_tv/media/dvb/video-stop.rst
index fd5288727911..2dbf464d85bb 100644
--- a/Documentation/linux_tv/media/dvb/video-stop.rst
+++ b/Documentation/linux_tv/media/dvb/video-stop.rst
@@ -2,28 +2,23 @@
.. _VIDEO_STOP:
+==========
VIDEO_STOP
==========
-Description
------------
-
-This ioctl is for DVB devices only. To control a V4L2 decoder use the
-V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+NAME
+----
-This ioctl call asks the Video Device to stop playing the current
-stream. Depending on the input parameter, the screen can be blanked out
-or displaying the last decoded frame.
+VIDEO_STOP
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -59,11 +54,20 @@ Arguments
- FALSE: Show last decoded frame.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is for DVB devices only. To control a V4L2 decoder use the
+V4L2 :ref:`VIDIOC_DECODER_CMD` instead.
+
+This ioctl call asks the Video Device to stop playing the current
+stream. Depending on the input parameter, the screen can be blanked out
+or displaying the last decoded frame.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/dvb/video-try-command.rst b/Documentation/linux_tv/media/dvb/video-try-command.rst
index 57eff3daf7bd..b30cfcd05682 100644
--- a/Documentation/linux_tv/media/dvb/video-try-command.rst
+++ b/Documentation/linux_tv/media/dvb/video-try-command.rst
@@ -2,30 +2,23 @@
.. _VIDEO_TRY_COMMAND:
+=================
VIDEO_TRY_COMMAND
=================
-Description
------------
-
-This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
-this ioctl has been replaced by the
-:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
+NAME
+----
-This ioctl tries a decoder command. The ``video_command`` struct is a
-subset of the ``v4l2_decoder_cmd`` struct, so refer to the
-:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
-for more information.
+VIDEO_TRY_COMMAND
-Synopsis
+SYNOPSIS
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
-Arguments
-----------
-
+ARGUMENTS
+---------
.. flat-table::
:header-rows: 0
@@ -51,11 +44,22 @@ Arguments
- Try a decoder command.
-Return Value
+DESCRIPTION
+-----------
+
+This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
+this ioctl has been replaced by the
+:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` ioctl.
+
+This ioctl tries a decoder command. The ``video_command`` struct is a
+subset of the ``v4l2_decoder_cmd`` struct, so refer to the
+:ref:`VIDIOC_TRY_DECODER_CMD <VIDIOC_DECODER_CMD>` documentation
+for more information.
+
+
+RETURN VALUE
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
diff --git a/Documentation/linux_tv/media/mediactl/media-func-close.rst b/Documentation/linux_tv/media/mediactl/media-func-close.rst
index 109b831e4047..7ec0baa83482 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-close.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-close.rst
@@ -6,12 +6,12 @@
media close()
*************
-*man media-close(2)*
+NAME
+====
-Close a media device
+media-close - Close a media device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,21 +21,22 @@ Synopsis
.. cpp:function:: int close( int fd )
-Arguments
+
+ARGUMENTS
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-Description
+DESCRIPTION
===========
Closes the media device. Resources associated with the file descriptor
are freed. The device configuration remain unchanged.
-Return Value
+RETURN VALUE
============
:ref:`close() <func-close>` returns 0 on success. On error, -1 is returned, and
diff --git a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
index c56ccb9c9b39..0d8f706b7e74 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
@@ -6,12 +6,12 @@
media ioctl()
*************
-*man media-ioctl(2)*
+NAME
+====
-Control a media device
+media-ioctl - Control a media device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: int ioctl( int fd, int request, void *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -35,7 +36,7 @@ Arguments
Pointer to a request-specific structure.
-Description
+DESCRIPTION
===========
The :ref:`ioctl() <func-ioctl>` function manipulates media device parameters.
@@ -51,7 +52,7 @@ requests, their respective function and parameters are specified in
:ref:`media-user-func`.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-func-open.rst b/Documentation/linux_tv/media/mediactl/media-func-open.rst
index 627860b33ae2..353114fcb7ca 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-open.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-open.rst
@@ -6,12 +6,12 @@
media open()
************
-*man media-open(2)*
+NAME
+====
-Open a media device
+media-open - Open a media device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: int open( const char *device_name, int flags )
-Arguments
+
+ARGUMENTS
=========
``device_name``
@@ -32,7 +33,7 @@ Arguments
Other flags have no effect.
-Description
+DESCRIPTION
===========
To open a media device applications call :ref:`open() <func-open>` with the
@@ -44,7 +45,7 @@ configuration will result in an error, and ``errno`` will be set to
EBADF.
-Return Value
+RETURN VALUE
============
:ref:`open() <func-open>` returns the new file descriptor on success. On error,
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst b/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst
index 8339e193ba8b..52fe981a4036 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst
@@ -6,17 +6,18 @@
ioctl MEDIA_IOC_DEVICE_INFO
***************************
-*man MEDIA_IOC_DEVICE_INFO(2)*
+NAME
+====
-Query device information
+MEDIA_IOC_DEVICE_INFO - Query device information
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct media_device_info *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
All media devices must support the ``MEDIA_IOC_DEVICE_INFO`` ioctl. To
@@ -132,7 +133,7 @@ used instead. The ``bus_info`` field is guaranteed to be unique, but can
vary across reboots or device unplug/replug.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
index 6e0a0c27ba2f..5d11572d4848 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
@@ -6,17 +6,18 @@
ioctl MEDIA_IOC_ENUM_ENTITIES
*****************************
-*man MEDIA_IOC_ENUM_ENTITIES(2)*
+NAME
+====
-Enumerate entities and their properties
+MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of an entity, applications set the id field of a
@@ -182,8 +183,7 @@ id's until they get an error.
-
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst b/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst
index 30dd7e2a7051..88bf10b35ff0 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst
@@ -6,17 +6,18 @@
ioctl MEDIA_IOC_ENUM_LINKS
**************************
-*man MEDIA_IOC_ENUM_LINKS(2)*
+NAME
+====
-Enumerate all pads and links for a given entity
+MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct media_links_enum *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To enumerate pads and/or links for a given entity, applications set the
@@ -158,8 +159,7 @@ returned during the enumeration process.
- Link flags, see :ref:`media-link-flag` for more details.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
index 1c360bf7c9b0..34d46010c971 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
@@ -6,17 +6,18 @@
ioctl MEDIA_IOC_G_TOPOLOGY
**************************
-*man MEDIA_IOC_G_TOPOLOGY(2)*
+NAME
+====
-Enumerate the graph topology and graph element properties
+MEDIA_IOC_G_TOPOLOGY - Enumerate the graph topology and graph element properties
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct media_v2_topology *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The typical usage of this ioctl is to call it twice. On the first call,
@@ -409,8 +410,7 @@ desired arrays with the media graph elements.
this array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst b/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst
index 135fa782dcd2..f02edbcd3048 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst
@@ -6,17 +6,18 @@
ioctl MEDIA_IOC_SETUP_LINK
**************************
-*man MEDIA_IOC_SETUP_LINK(2)*
+NAME
+====
-Modify the properties of a link
+MEDIA_IOC_SETUP_LINK - Modify the properties of a link
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To change link properties applications fill a struct
@@ -53,7 +54,7 @@ If the specified link can't be found the driver returns with an ``EINVAL``
error code.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/func-close.rst b/Documentation/linux_tv/media/v4l/func-close.rst
index fac5ec14a8e6..81401cd26d12 100644
--- a/Documentation/linux_tv/media/v4l/func-close.rst
+++ b/Documentation/linux_tv/media/v4l/func-close.rst
@@ -6,12 +6,12 @@
V4L2 close()
************
-*man v4l2-close(2)*
+NAME
+====
-Close a V4L2 device
+v4l2-close - Close a V4L2 device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,14 +21,15 @@ Synopsis
.. cpp:function:: int close( int fd )
-Arguments
+
+ARGUMENTS
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-Description
+DESCRIPTION
===========
Closes the device. Any I/O in progress is terminated and resources
@@ -37,7 +38,7 @@ parameters, current input or output, control values or other properties
remain unchanged.
-Return Value
+RETURN VALUE
============
The function returns 0 on success, -1 on failure and the ``errno`` is
diff --git a/Documentation/linux_tv/media/v4l/func-ioctl.rst b/Documentation/linux_tv/media/v4l/func-ioctl.rst
index fafec5f56a36..91917e976dd0 100644
--- a/Documentation/linux_tv/media/v4l/func-ioctl.rst
+++ b/Documentation/linux_tv/media/v4l/func-ioctl.rst
@@ -6,12 +6,12 @@
V4L2 ioctl()
************
-*man v4l2-ioctl(2)*
+NAME
+====
-Program a V4L2 device
+v4l2-ioctl - Program a V4L2 device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: int ioctl( int fd, int request, void *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -35,7 +36,7 @@ Arguments
Pointer to a function parameter, usually a structure.
-Description
+DESCRIPTION
===========
The :ref:`ioctl() <func-ioctl>` function is used to program V4L2 devices. The
@@ -49,7 +50,7 @@ All V4L2 ioctl requests, their respective function and parameters are
specified in :ref:`user-func`.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/func-mmap.rst b/Documentation/linux_tv/media/v4l/func-mmap.rst
index 345ac3005c8f..01a45e217265 100644
--- a/Documentation/linux_tv/media/v4l/func-mmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-mmap.rst
@@ -6,12 +6,12 @@
V4L2 mmap()
***********
-*man v4l2-mmap(2)*
+NAME
+====
-Map device memory into application address space
+v4l2-mmap - Map device memory into application address space
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -22,7 +22,8 @@ Synopsis
.. cpp:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset )
-Arguments
+
+ARGUMENTS
=========
``start``
@@ -89,7 +90,7 @@ Arguments
``mem_offset`` field for the multi-planar API.
-Description
+DESCRIPTION
===========
The :ref:`mmap() <func-mmap>` function asks to map ``length`` bytes starting at
@@ -105,7 +106,7 @@ before they can be queried.
To unmap buffers the :ref:`munmap() <func-munmap>` function is used.
-Return Value
+RETURN VALUE
============
On success :ref:`mmap() <func-mmap>` returns a pointer to the mapped buffer. On
diff --git a/Documentation/linux_tv/media/v4l/func-munmap.rst b/Documentation/linux_tv/media/v4l/func-munmap.rst
index f87eb387f499..a6e7a6def558 100644
--- a/Documentation/linux_tv/media/v4l/func-munmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-munmap.rst
@@ -6,12 +6,12 @@
V4L2 munmap()
*************
-*man v4l2-munmap(2)*
+NAME
+====
-Unmap device memory
+v4l2-munmap - Unmap device memory
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -22,7 +22,8 @@ Synopsis
.. cpp:function:: int munmap( void *start, size_t length )
-Arguments
+
+ARGUMENTS
=========
``start``
@@ -38,14 +39,14 @@ Arguments
multi-planar API.
-Description
+DESCRIPTION
===========
Unmaps a previously with the :ref:`mmap() <func-mmap>` function mapped
buffer and frees it, if possible.
-Return Value
+RETURN VALUE
============
On success :ref:`munmap() <func-munmap>` returns 0, on failure -1 and the
diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst
index 705175be80e6..152174e6f646 100644
--- a/Documentation/linux_tv/media/v4l/func-open.rst
+++ b/Documentation/linux_tv/media/v4l/func-open.rst
@@ -6,12 +6,12 @@
V4L2 open()
***********
-*man v4l2-open(2)*
+NAME
+====
-Open a V4L2 device
+v4l2-open - Open a V4L2 device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: int open( const char *device_name, int flags )
-Arguments
+
+ARGUMENTS
=========
``device_name``
@@ -42,7 +43,7 @@ Arguments
Other flags have no effect.
-Description
+DESCRIPTION
===========
To open a V4L2 device applications call :ref:`open() <func-open>` with the
@@ -53,7 +54,7 @@ driver they will be reset to default values, drivers are never in an
undefined state.
-Return Value
+RETURN VALUE
============
On success :ref:`open() <func-open>` returns the new file descriptor. On error
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index 27f381d75de1..8632e05ff5b2 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -6,12 +6,12 @@
V4L2 poll()
***********
-*man v4l2-poll(2)*
+NAME
+====
-Wait for some event on a file descriptor
+v4l2-poll - Wait for some event on a file descriptor
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,13 @@ Synopsis
.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
-Description
+
+ARGUMENTS
+=========
+
+
+
+DESCRIPTION
===========
With the :ref:`poll() <func-poll>` function applications can suspend execution
@@ -84,7 +90,7 @@ function.
For more details see the :ref:`poll() <func-poll>` manual page.
-Return Value
+RETURN VALUE
============
On success, :ref:`poll() <func-poll>` returns the number structures which have
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index 75985f664da7..c4f0e8ab9e14 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -6,12 +6,12 @@
V4L2 read()
***********
-*man v4l2-read(2)*
+NAME
+====
-Read from a V4L2 device
+v4l2-read - Read from a V4L2 device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: ssize_t read( int fd, void *buf, size_t count )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +32,7 @@ Arguments
``count``
-Description
+DESCRIPTION
===========
:ref:`read() <func-read>` attempts to read up to ``count`` bytes from file
@@ -91,7 +92,7 @@ however. The discarding policy is not reported and cannot be changed.
For minimum requirements see :ref:`devices`.
-Return Value
+RETURN VALUE
============
On success, the number of bytes read is returned. It is not an error if
diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst
index 57089f5cc6cd..34ade67d0f68 100644
--- a/Documentation/linux_tv/media/v4l/func-select.rst
+++ b/Documentation/linux_tv/media/v4l/func-select.rst
@@ -6,12 +6,12 @@
V4L2 select()
*************
-*man v4l2-select(2)*
+NAME
+====
-Synchronous I/O multiplexing
+v4l2-select - Synchronous I/O multiplexing
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -23,7 +23,13 @@ Synopsis
.. cpp:function:: int select( int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout )
-Description
+
+ARGUMENTS
+=========
+
+
+
+DESCRIPTION
===========
With the :ref:`select() <func-select>` function applications can suspend
@@ -65,7 +71,7 @@ function.
For more details see the :ref:`select() <func-select>` manual page.
-Return Value
+RETURN VALUE
============
On success, :ref:`select() <func-select>` returns the number of descriptors
diff --git a/Documentation/linux_tv/media/v4l/func-write.rst b/Documentation/linux_tv/media/v4l/func-write.rst
index a4b093ba15c3..6609f191af76 100644
--- a/Documentation/linux_tv/media/v4l/func-write.rst
+++ b/Documentation/linux_tv/media/v4l/func-write.rst
@@ -6,12 +6,12 @@
V4L2 write()
************
-*man v4l2-write(2)*
+NAME
+====
-Write to a V4L2 device
+v4l2-write - Write to a V4L2 device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: ssize_t write( int fd, void *buf, size_t count )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +32,7 @@ Arguments
``count``
-Description
+DESCRIPTION
===========
:ref:`write() <func-write>` writes up to ``count`` bytes to the device
@@ -46,7 +47,7 @@ Sliced Teletext or Closed Caption data is not repeated, the driver
inserts a blank line instead.
-Return Value
+RETURN VALUE
============
On success, the number of bytes written are returned. Zero indicates
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index 5ba95ac0a5ce..fe179197536d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_CREATE_BUFS
************************
-*man VIDIOC_CREATE_BUFS(2)*
+NAME
+====
-Create buffers for Memory Mapped or User Pointer or DMA Buffer I/O
+VIDIOC_CREATE_BUFS - Create buffers for Memory Mapped or User Pointer or DMA Buffer I/O
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_create_buffers *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
This ioctl is used to create buffers for :ref:`memory mapped <mmap>`
@@ -129,8 +130,7 @@ than the number requested.
must set the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
index 2e2a24f652a3..17ae3aa738b0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_CROPCAP
********************
-*man VIDIOC_CROPCAP(2)*
+NAME
+====
-Information about the video cropping and scaling abilities
+VIDIOC_CROPCAP - Information about the video cropping and scaling abilities
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Applications use this function to query the cropping limits, the pixel
@@ -153,8 +154,7 @@ overlay devices.
- Height of the rectangle, in pixels.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index 7cc3bd42ccd4..913c6d47d821 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_DBG_G_CHIP_INFO
****************************
-*man VIDIOC_DBG_G_CHIP_INFO(2)*
+NAME
+====
-Identify the chips on a TV card
+VIDIOC_DBG_G_CHIP_INFO - Identify the chips on a TV card
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_chip_info *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
**Note**
@@ -191,8 +192,7 @@ instructions.
- Match the nth sub-device.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
index f83a83b48cd6..185a011a117c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER
**************************************************
-*man VIDIOC_DBG_G_REGISTER(2)*
+NAME
+====
-VIDIOC_DBG_S_REGISTER
-Read or write hardware registers
+VIDIOC_DBG_G_REGISTER - VIDIOC_DBG_S_REGISTER - Read or write hardware registers
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_register *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
**Note**
@@ -196,8 +196,7 @@ instructions.
- Match the nth sub-device.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
index c1d82336a60a..bb6d9b8cf122 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
************************************************
-*man VIDIOC_DECODER_CMD(2)*
+NAME
+====
-VIDIOC_TRY_DECODER_CMD
-Execute an decoder command
+VIDIOC_DECODER_CMD - VIDIOC_TRY_DECODER_CMD - Execute an decoder command
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls control an audio/video (usually MPEG-) decoder.
@@ -255,8 +255,7 @@ introduced in Linux 3.3.
flags are defined for this command.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
index 4d813a903693..850cb5ed0015 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_DQEVENT
********************
-*man VIDIOC_DQEVENT(2)*
+NAME
+====
-Dequeue event
+VIDIOC_DQEVENT - Dequeue event
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Dequeue an event from a video device. No input is required for this
@@ -563,8 +564,7 @@ call.
decoder.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
index 475dbb75aef3..61fef531363c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP
*********************************************************
-*man VIDIOC_DV_TIMINGS_CAP(2)*
+NAME
+====
-VIDIOC_SUBDEV_DV_TIMINGS_CAP
-The capabilities of the Digital Video receiver/transmitter
+VIDIOC_DV_TIMINGS_CAP - VIDIOC_SUBDEV_DV_TIMINGS_CAP - The capabilities of the Digital Video receiver/transmitter
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the capabilities of the DV receiver/transmitter applications
@@ -241,8 +241,7 @@ that doesn't support them will return an ``EINVAL`` error code.
the standards set in the ``standards`` field.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
index 78c014ded43b..1991014fd6b5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD
************************************************
-*man VIDIOC_ENCODER_CMD(2)*
+NAME
+====
-VIDIOC_TRY_ENCODER_CMD
-Execute an encoder command
+VIDIOC_ENCODER_CMD - VIDIOC_TRY_ENCODER_CMD - Execute an encoder command
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls control an audio/video (usually MPEG-) encoder.
@@ -179,8 +179,7 @@ introduced in Linux 2.6.21.
rather than immediately.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
index 5aa2db9076a0..41fa4313c1c2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS
***********************************************************
-*man VIDIOC_ENUM_DV_TIMINGS(2)*
+NAME
+====
-VIDIOC_SUBDEV_ENUM_DV_TIMINGS
-Enumerate supported Digital Video timings
+VIDIOC_ENUM_DV_TIMINGS - VIDIOC_SUBDEV_ENUM_DV_TIMINGS - Enumerate supported Digital Video timings
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
While some DV receivers or transmitters support a wide range of timings,
@@ -103,8 +103,7 @@ return an ``EINVAL`` error code.
- The timings.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
index 5cc97ce281ef..3b935b07837a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUM_FMT
*********************
-*man VIDIOC_ENUM_FMT(2)*
+NAME
+====
-Enumerate image formats
+VIDIOC_ENUM_FMT - Enumerate image formats
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To enumerate image formats applications initialize the ``type`` and
@@ -150,8 +151,7 @@ formats may be different.
format instead for better performance.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
index 29cf2fa5ba87..3336a166b878 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUM_FRAMEINTERVALS
********************************
-*man VIDIOC_ENUM_FRAMEINTERVALS(2)*
+NAME
+====
-Enumerate frame intervals
+VIDIOC_ENUM_FRAMEINTERVALS - Enumerate frame intervals
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +32,7 @@ Arguments
interval.
-Description
+DESCRIPTION
===========
This ioctl allows applications to enumerate all frame intervals that the
@@ -264,8 +265,7 @@ Enums
- Step-wise defined frame interval.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
index 396cdcf44c7e..d01fffaeda04 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUM_FRAMESIZES
****************************
-*man VIDIOC_ENUM_FRAMESIZES(2)*
+NAME
+====
-Enumerate frame sizes
+VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +32,7 @@ Arguments
and height.
-Description
+DESCRIPTION
===========
This ioctl allows applications to enumerate all frame sizes (i. e. width
@@ -281,8 +282,7 @@ Enums
- Step-wise defined frame size.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
index da3bda140965..7fdde4be282c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUM_FREQ_BANDS
****************************
-*man VIDIOC_ENUM_FREQ_BANDS(2)*
+NAME
+====
-Enumerate supported frequency bands
+VIDIOC_ENUM_FREQ_BANDS - Enumerate supported frequency bands
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Enumerates the frequency bands that a tuner or modulator supports. To do
@@ -176,8 +177,7 @@ of the corresponding tuner/modulator is set.
- Amplitude Modulation, commonly used for analog radio.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index 9573e54271fc..f833e581f7c3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUMAUDIO
**********************
-*man VIDIOC_ENUMAUDIO(2)*
+NAME
+====
-Enumerate audio inputs
+VIDIOC_ENUMAUDIO - Enumerate audio inputs
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of an audio input applications initialize the
@@ -43,7 +44,7 @@ See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct
:ref:`v4l2_audio <v4l2-audio>`.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index 82ffb3194ed3..f2caf6c71f44 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUMAUDOUT
***********************
-*man VIDIOC_ENUMAUDOUT(2)*
+NAME
+====
-Enumerate audio outputs
+VIDIOC_ENUMAUDOUT - Enumerate audio outputs
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of an audio output applications initialize the
@@ -46,7 +47,7 @@ See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDIOout>` for a description of struct
:ref:`v4l2_audioout <v4l2-audioout>`.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
index d27556c112bb..01a1cadc71d2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUMINPUT
**********************
-*man VIDIOC_ENUMINPUT(2)*
+NAME
+====
-Enumerate video inputs
+VIDIOC_ENUMINPUT - Enumerate video inputs
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_input *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of a video input applications initialize the
@@ -353,8 +354,7 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
:ref:`v4l2-selections-common`.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
index a0a9a375ef3f..99c70e54c4d6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUMOUTPUT
***********************
-*man VIDIOC_ENUMOUTPUT(2)*
+NAME
+====
-Enumerate video outputs
+VIDIOC_ENUMOUTPUT - Enumerate video outputs
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of a video outputs applications initialize the
@@ -208,8 +209,7 @@ EINVAL.
:ref:`v4l2-selections-common`.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index 718b29510eeb..e74514ea4437 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_ENUMSTD
********************
-*man VIDIOC_ENUMSTD(2)*
+NAME
+====
-Enumerate supported video standards
+VIDIOC_ENUMSTD - Enumerate supported video standards
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_standard *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of a video standard, especially a custom (driver
@@ -384,8 +385,7 @@ support digital TV. See also the Linux DVB API at
- + 6.5 [8]_
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
index 548b15a841c3..2c08a349ab45 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_EXPBUF
*******************
-*man VIDIOC_EXPBUF(2)*
+NAME
+====
-Export a buffer as a DMABUF file descriptor.
+VIDIOC_EXPBUF - Export a buffer as a DMABUF file descriptor.
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O
@@ -183,8 +184,7 @@ Examples
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index d0bdc2d36734..02db00a31722 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
************************************
-*man VIDIOC_G_AUDIO(2)*
+NAME
+====
-VIDIOC_S_AUDIO
-Query or select the current audio input and its attributes
+VIDIOC_G_AUDIO - VIDIOC_S_AUDIO - Query or select the current audio input and its attributes
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the current audio input applications zero out the ``reserved``
@@ -149,8 +149,7 @@ return the actual new audio mode.
- AVL mode is on.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index 7f13b6fbb73d..9265be57d0f9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
**************************************
-*man VIDIOC_G_AUDOUT(2)*
+NAME
+====
-VIDIOC_S_AUDOUT
-Query or select the current audio output
+VIDIOC_G_AUDOUT - VIDIOC_S_AUDOUT - Query or select the current audio output
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the current audio output applications zero out the ``reserved``
@@ -108,8 +108,7 @@ sound card are not audio outputs in this sense.
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index a368636b305d..206fdd5f825f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_CROP, VIDIOC_S_CROP
**********************************
-*man VIDIOC_G_CROP(2)*
+NAME
+====
-VIDIOC_S_CROP
-Get or set the current cropping rectangle
+VIDIOC_G_CROP - VIDIOC_S_CROP - Get or set the current cropping rectangle
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_crop *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the cropping rectangle size and position applications set the
@@ -104,8 +104,7 @@ When cropping is not supported then no parameters are changed and
:ref:`v4l2_cropcap <v4l2-cropcap>` ``bounds`` is used.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index db1e7b252147..50fddb140288 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL
**********************************
-*man VIDIOC_G_CTRL(2)*
+NAME
+====
-VIDIOC_S_CTRL
-Get or set the value of a control
+VIDIOC_G_CTRL - VIDIOC_S_CTRL - Get or set the value of a control
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_control *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To get the current value of a control applications initialize the ``id``
@@ -78,8 +78,7 @@ These ioctls work only with user controls. For other control classes the
- New value or current value.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index 8c72b2d461d3..f6e7fd261ebc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -6,20 +6,18 @@
ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS
**********************************************
-*man VIDIOC_G_DV_TIMINGS(2)*
+NAME
+====
-VIDIOC_S_DV_TIMINGS
-VIDIOC_SUBDEV_G_DV_TIMINGS
-VIDIOC_SUBDEV_S_DV_TIMINGS
-Get or set DV timings for input or output
+VIDIOC_G_DV_TIMINGS - VIDIOC_S_DV_TIMINGS - VIDIOC_SUBDEV_G_DV_TIMINGS - VIDIOC_SUBDEV_S_DV_TIMINGS - Get or set DV timings for input or output
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -32,7 +30,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To set DV timings for the input or output, applications use the
@@ -51,7 +49,7 @@ the current input or output does not support DV timings (e.g. if
``V4L2_IN_CAP_DV_TIMINGS`` flag), then ``ENODATA`` error code is returned.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index cbed4805f017..1414026f5740 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -6,20 +6,18 @@
ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID
******************************************************************************
-*man VIDIOC_G_EDID(2)*
+NAME
+====
-VIDIOC_S_EDID
-VIDIOC_SUBDEV_G_EDID
-VIDIOC_SUBDEV_S_EDID
-Get or set the EDID of a video receiver/transmitter
+VIDIOC_G_EDID - VIDIOC_S_EDID - VIDIOC_SUBDEV_G_EDID - VIDIOC_SUBDEV_S_EDID - Get or set the EDID of a video receiver/transmitter
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -32,7 +30,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls can be used to get or set an EDID associated with an input
@@ -145,8 +143,7 @@ EDID is no longer available.
``blocks`` * 128.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
index 0ae21890dd61..16f0e8135952 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_G_ENC_INDEX
************************
-*man VIDIOC_G_ENC_INDEX(2)*
+NAME
+====
-Get meta data about a compressed video stream
+VIDIOC_G_ENC_INDEX - Get meta data about a compressed video stream
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enc_idx *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` ioctl provides meta data about a compressed
@@ -200,8 +201,7 @@ video elementary streams.
type.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index 9a2cc1b98c43..2f69b1cf804b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -6,19 +6,18 @@
ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS
******************************************************************
-*man VIDIOC_G_EXT_CTRLS(2)*
+NAME
+====
-VIDIOC_S_EXT_CTRLS
-VIDIOC_TRY_EXT_CTRLS
-Get or set the value of several controls, try control values
+VIDIOC_G_EXT_CTRLS - VIDIOC_S_EXT_CTRLS - VIDIOC_TRY_EXT_CTRLS - Get or set the value of several controls, try control values
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +30,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls allow the caller to get or set multiple controls
@@ -452,8 +451,7 @@ still cause this situation.
described in :ref:`rf-tuner-controls`.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index 05a477f4925c..4d0799414420 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF
**********************************
-*man VIDIOC_G_FBUF(2)*
+NAME
+====
-VIDIOC_S_FBUF
-Get or set frame buffer overlay parameters
+VIDIOC_G_FBUF - VIDIOC_S_FBUF - Get or set frame buffer overlay parameters
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_framebuffer *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Applications can use the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl
@@ -477,8 +477,7 @@ destructive video overlay.
:ref:`v4l2_window <v4l2-window>` is being used.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index 4e56ff72ddcb..aede100b668b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -6,19 +6,18 @@
ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
************************************************
-*man VIDIOC_G_FMT(2)*
+NAME
+====
-VIDIOC_S_FMT
-VIDIOC_TRY_FMT
-Get or set the data format, try a format
+VIDIOC_G_FMT - VIDIOC_S_FMT - VIDIOC_TRY_FMT - Get or set the data format, try a format
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -30,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls are used to negotiate the format of data (typically image
@@ -176,8 +175,7 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
- Place holder for future extensions.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
index e5c49033b5a1..2b921cda2e4d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
********************************************
-*man VIDIOC_G_FREQUENCY(2)*
+NAME
+====
-VIDIOC_S_FREQUENCY
-Get or set tuner or modulator radio frequency
+VIDIOC_G_FREQUENCY - VIDIOC_S_FREQUENCY - Get or set tuner or modulator radio frequency
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To get the current tuner or modulator radio frequency applications set
@@ -107,8 +107,7 @@ write-only ioctl, it does not return the actual new frequency.
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index aae135ea2a77..e069ba3952ea 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT
************************************
-*man VIDIOC_G_INPUT(2)*
+NAME
+====
-VIDIOC_S_INPUT
-Query or select the current video input
+VIDIOC_G_INPUT - VIDIOC_S_INPUT - Query or select the current video input
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, int *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the current video input applications call the
@@ -50,7 +50,7 @@ Information about video inputs is available using the
:ref:`VIDIOC_ENUMINPUT` ioctl.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
index cea36cf3af17..c8d3a3b53a51 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
@@ -6,18 +6,20 @@
ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP
******************************************
-*man VIDIOC_G_JPEGCOMP(2)*
+NAME
+====
-VIDIOC_S_JPEGCOMP
+VIDIOC_G_JPEGCOMP - VIDIOC_S_JPEGCOMP
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp )
.. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls are **deprecated**. New drivers and applications should use
@@ -173,8 +175,7 @@ encoding. You usually do want to add them.
- App segment, driver will always use APP0
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index 7fe256319682..21b9fea34b8c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR
********************************************
-*man VIDIOC_G_MODULATOR(2)*
+NAME
+====
-VIDIOC_S_MODULATOR
-Get or set modulator attributes
+VIDIOC_G_MODULATOR - VIDIOC_S_MODULATOR - Get or set modulator attributes
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_modulator *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of a modulator applications initialize the
@@ -242,8 +242,7 @@ To change the radio frequency the
- Enable the RDS encoder for a radio FM transmitter.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index cd0646eb7539..c9fb075ec5d1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT
**************************************
-*man VIDIOC_G_OUTPUT(2)*
+NAME
+====
-VIDIOC_S_OUTPUT
-Query or select the current video output
+VIDIOC_G_OUTPUT - VIDIOC_S_OUTPUT - Query or select the current video output
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, int *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the current video output applications call the
@@ -51,7 +51,7 @@ Information about video outputs is available using the
:ref:`VIDIOC_ENUMOUTPUT` ioctl.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 7dbf1b5e918e..964e3b8ce275 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_G_PARM, VIDIOC_S_PARM
**********************************
-*man VIDIOC_G_PARM(2)*
+NAME
+====
-VIDIOC_S_PARM
-Get or set streaming parameters
+VIDIOC_G_PARM - VIDIOC_S_PARM - Get or set streaming parameters
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_streamparm *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The current video standard determines a nominal number of frames per
@@ -340,8 +340,7 @@ union holding separate parameters for input and output devices.
- Capture might only work through the :ref:`read() <func-read>` call.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
index 1551f3139899..8255f2469cd9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY
******************************************
-*man VIDIOC_G_PRIORITY(2)*
+NAME
+====
-VIDIOC_S_PRIORITY
-Query or request the access priority associated with a file descriptor
+VIDIOC_G_PRIORITY - VIDIOC_S_PRIORITY - Query or request the access priority associated with a file descriptor
-
-Synopsis
+SYNOPSIS
========
.. c:function:: int ioctl( int fd, int request, enum v4l2_priority *argp )
.. c:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -32,7 +32,7 @@ Arguments
Pointer to an enum v4l2_priority type.
-Description
+DESCRIPTION
===========
To query the current access priority applications call the
@@ -102,8 +102,7 @@ with a pointer to this variable.
applications which must not be interrupted, like video recording.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
index 609510a03cde..c4164eaafca8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
********************************************
-*man VIDIOC_G_SELECTION(2)*
+NAME
+====
-VIDIOC_S_SELECTION
-Get or set one of the selection rectangles
+VIDIOC_G_SELECTION - VIDIOC_S_SELECTION - Get or set one of the selection rectangles
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_selection *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The ioctls are used to query and configure selection rectangles.
@@ -187,8 +187,7 @@ Selection targets and flags are documented in
this array.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index 39d297836824..466760241fdb 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_G_SLICED_VBI_CAP
*****************************
-*man VIDIOC_G_SLICED_VBI_CAP(2)*
+NAME
+====
-Query sliced VBI capabilities
+VIDIOC_G_SLICED_VBI_CAP - Query sliced VBI capabilities
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_sliced_vbi_cap *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To find out which data services are supported by a sliced VBI capture or
@@ -263,8 +264,7 @@ to write-read, in Linux 2.6.19.
- :cspan:`2` Set of services applicable to 625 line systems.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index e1e3bb7fa726..4fbc9e9bfeb8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_STD, VIDIOC_S_STD
********************************
-*man VIDIOC_G_STD(2)*
+NAME
+====
-VIDIOC_S_STD
-Query or select the video standard of the current input
+VIDIOC_G_STD - VIDIOC_S_STD - Query or select the video standard of the current input
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
.. cpp:function:: int ioctl( int fd, int request, const v4l2_std_id *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query and select the current video standard applications use the
@@ -53,7 +53,7 @@ does not set the ``V4L2_IN_CAP_STD`` flag), then ``ENODATA`` error code is
returned.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index eee4acfcf3cf..fe904db57597 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER
************************************
-*man VIDIOC_G_TUNER(2)*
+NAME
+====
-VIDIOC_S_TUNER
-Get or set tuner attributes
+VIDIOC_G_TUNER - VIDIOC_S_TUNER - Get or set tuner attributes
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_tuner *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of a tuner applications initialize the ``index``
@@ -692,8 +692,7 @@ To change the radio frequency the
- Lang1/Lang2 (preferred) or Lang1/Lang1
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
index afff82efe392..d96d5e4f242a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
@@ -6,17 +6,23 @@
ioctl VIDIOC_LOG_STATUS
***********************
-*man VIDIOC_LOG_STATUS(2)*
+NAME
+====
-Log driver status information
+VIDIOC_LOG_STATUS - Log driver status information
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request )
-Description
+
+ARGUMENTS
+=========
+
+
+
+DESCRIPTION
===========
As the video/audio devices become more complicated it becomes harder to
@@ -31,7 +37,7 @@ This ioctl is optional and not all drivers support it. It was introduced
in Linux 2.6.15.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
index 41ddeea5537f..cd58a34a7ee8 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_OVERLAY
********************
-*man VIDIOC_OVERLAY(2)*
+NAME
+====
-Start or stop video overlay
+VIDIOC_OVERLAY - Start or stop video overlay
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, const int *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
@@ -41,7 +42,7 @@ Drivers do not support :ref:`VIDIOC_STREAMON` or
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
index 2c88d3cedecf..0f51082f8c93 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_PREPARE_BUF
************************
-*man VIDIOC_PREPARE_BUF(2)*
+NAME
+====
-Prepare a buffer for I/O
+VIDIOC_PREPARE_BUF - Prepare a buffer for I/O
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to
@@ -44,7 +45,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index 88179f8019fa..bf41f30cf9c4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_QBUF, VIDIOC_DQBUF
*******************************
-*man VIDIOC_QBUF(2)*
+NAME
+====
-VIDIOC_DQBUF
-Exchange a buffer with the driver
+VIDIOC_QBUF - VIDIOC_DQBUF - Exchange a buffer with the driver
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Applications call the ``VIDIOC_QBUF`` ioctl to enqueue an empty
@@ -116,7 +116,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index 6a37b6503399..38295fd5f1ad 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_QUERY_DV_TIMINGS
*****************************
-*man VIDIOC_QUERY_DV_TIMINGS(2)*
+NAME
+====
-VIDIOC_SUBDEV_QUERY_DV_TIMINGS
-Sense the DV preset received by the current input
+VIDIOC_QUERY_DV_TIMINGS - VIDIOC_SUBDEV_QUERY_DV_TIMINGS - Sense the DV preset received by the current input
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The hardware may be able to detect the current DV timings automatically,
@@ -61,7 +61,7 @@ found timings with the hardware's capabilities in order to give more
precise feedback to the user.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index 2fae7021b511..6454c302644d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_QUERYBUF
*********************
-*man VIDIOC_QUERYBUF(2)*
+NAME
+====
-Query the status of a buffer
+VIDIOC_QUERYBUF - Query the status of a buffer
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can
@@ -67,7 +68,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
index 0051c483a323..406c5eb34034 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_QUERYCAP
*********************
-*man VIDIOC_QUERYCAP(2)*
+NAME
+====
-Query device capabilities
+VIDIOC_QUERYCAP - Query device capabilities
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
All V4L2 devices support the ``VIDIOC_QUERYCAP`` ioctl. It is used to
@@ -419,8 +420,7 @@ specification the ioctl returns an ``EINVAL`` error code.
``device_caps`` field.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 93e524c7e38d..4e0eb7b04fd2 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -6,14 +6,12 @@
ioctls VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU
*******************************************************************
-*man VIDIOC_QUERYCTRL(2)*
+NAME
+====
-VIDIOC_QUERY_EXT_CTRL
-VIDIOC_QUERYMENU
-Enumerate controls and menu control items
+VIDIOC_QUERYCTRL - VIDIOC_QUERY_EXT_CTRL - VIDIOC_QUERYMENU - Enumerate controls and menu control items
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp )
@@ -22,7 +20,8 @@ Synopsis
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -34,7 +33,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To query the attributes of a control applications set the ``id`` field
@@ -754,8 +753,7 @@ See also the examples in :ref:`control`.
``V4L2_CTRL_TYPE_BUTTON`` have this flag set.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
index 8d6769f2b5c6..fe540f80ef60 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_QUERYSTD
*********************
-*man VIDIOC_QUERYSTD(2)*
+NAME
+====
-Sense the video standard received by the current input
+VIDIOC_QUERYSTD - Sense the video standard received by the current input
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The hardware may be able to detect the current video standard
@@ -53,7 +54,7 @@ standard is valid they will have to stop streaming, set the new
standard, allocate new buffers and start streaming again.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index 6803f21c8f4f..2e27708fd7a6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_REQBUFS
********************
-*man VIDIOC_REQBUFS(2)*
+NAME
+====
-Initiate Memory Mapping or User Pointer I/O
+VIDIOC_REQBUFS - Initiate Memory Mapping or User Pointer I/O
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
This ioctl is used to initiate :ref:`memory mapped <mmap>`,
@@ -111,8 +112,7 @@ any DMA in progress, an implicit
must set the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
index efa5e930b3bb..068a67e8a523 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_S_HW_FREQ_SEEK
***************************
-*man VIDIOC_S_HW_FREQ_SEEK(2)*
+NAME
+====
-Perform a hardware frequency seek
+VIDIOC_S_HW_FREQ_SEEK - Perform a hardware frequency seek
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_hw_freq_seek *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Start a hardware frequency seek from the current frequency. To do this
@@ -154,8 +155,7 @@ error code is returned and no seek takes place.
zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
index c3ea38c6cb5b..0e6b750f8718 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF
***************************************
-*man VIDIOC_STREAMON(2)*
+NAME
+====
-VIDIOC_STREAMOFF
-Start or stop streaming I/O
+VIDIOC_STREAMON - VIDIOC_STREAMOFF - Start or stop streaming I/O
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, const int *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The ``VIDIOC_STREAMON`` and ``VIDIOC_STREAMOFF`` ioctl start and stop
@@ -81,7 +81,7 @@ no notion of starting or stopping "now". Buffer timestamps can be used
to synchronize with other events.
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index d22926a6257b..0d2b690cf8bc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL
***************************************
-*man VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL(2)*
+NAME
+====
-Enumerate frame intervals
+VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL - Enumerate frame intervals
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval_enum * argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
This ioctl lets applications enumerate available frame intervals on a
@@ -136,8 +137,7 @@ multiple pads of the same sub-device is not defined.
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
index 91738510b122..c52a02df5b16 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE
***********************************
-*man VIDIOC_SUBDEV_ENUM_FRAME_SIZE(2)*
+NAME
+====
-Enumerate media bus frame sizes
+VIDIOC_SUBDEV_ENUM_FRAME_SIZE - Enumerate media bus frame sizes
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_size_enum * argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
This ioctl allows applications to enumerate all frame sizes supported by
@@ -146,8 +147,7 @@ information about try formats.
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index da0d0407346c..1ff173e502f7 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -6,17 +6,18 @@
ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE
**********************************
-*man VIDIOC_SUBDEV_ENUM_MBUS_CODE(2)*
+NAME
+====
-Enumerate media bus formats
+VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -28,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
To enumerate media bus formats available at a given sub-device pad
@@ -99,8 +100,7 @@ information about the try formats.
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
index eb13718a4654..94bffa78c486 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
@@ -6,20 +6,20 @@
ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP
************************************************
-*man VIDIOC_SUBDEV_G_CROP(2)*
+NAME
+====
-VIDIOC_SUBDEV_S_CROP
-Get or set the crop rectangle on a subdev pad
+VIDIOC_SUBDEV_G_CROP - VIDIOC_SUBDEV_S_CROP - Get or set the crop rectangle on a subdev pad
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp )
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +31,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
**Note**
@@ -114,8 +114,7 @@ modified format should be as close as possible to the original request.
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
index 9de901ad7cdd..13615c0d0392 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_SUBDEV_G_FMT, VIDIOC_SUBDEV_S_FMT
**********************************************
-*man VIDIOC_SUBDEV_G_FMT(2)*
+NAME
+====
-VIDIOC_SUBDEV_S_FMT
-Get or set the data format on a subdev pad
+VIDIOC_SUBDEV_G_FMT - VIDIOC_SUBDEV_S_FMT - Get or set the data format on a subdev pad
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls are used to negotiate the frame format at specific subdev
@@ -144,8 +144,7 @@ should be as close as possible to the original request.
- Active formats, applied to the hardware.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
@@ -164,7 +163,6 @@ EINVAL
references a non-existing format.
-Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
index 947fbf0f9a23..05f5bfb3f1ca 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL
********************************************************************
-*man VIDIOC_SUBDEV_G_FRAME_INTERVAL(2)*
+NAME
+====
-VIDIOC_SUBDEV_S_FRAME_INTERVAL
-Get or set the frame interval on a subdev pad
+VIDIOC_SUBDEV_G_FRAME_INTERVAL - VIDIOC_SUBDEV_S_FRAME_INTERVAL - Get or set the frame interval on a subdev pad
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -30,7 +30,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
These ioctls are used to get and set the frame interval at specific
@@ -100,8 +100,7 @@ the same sub-device is not defined.
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
index fa6dcccd0a2b..dd0dab7d7e42 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
**********************************************************
-*man VIDIOC_SUBDEV_G_SELECTION(2)*
+NAME
+====
-VIDIOC_SUBDEV_S_SELECTION
-Get or set selection rectangles on a subdev pad
+VIDIOC_SUBDEV_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
The selections are used to configure various image processing
@@ -122,8 +122,7 @@ Selection targets and flags are documented in
the array to zero.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
index 8beba56d62b9..2ecce157f852 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
@@ -6,18 +6,18 @@
ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT
******************************************************
-*man VIDIOC_SUBSCRIBE_EVENT(2)*
+NAME
+====
-VIDIOC_UNSUBSCRIBE_EVENT
-Subscribe or unsubscribe event
+VIDIOC_SUBSCRIBE_EVENT - VIDIOC_UNSUBSCRIBE_EVENT - Subscribe or unsubscribe event
-
-Synopsis
+SYNOPSIS
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event_subscription *argp )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -29,7 +29,7 @@ Arguments
``argp``
-Description
+DESCRIPTION
===========
Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by
@@ -126,8 +126,7 @@ using the :ref:`VIDIOC_DQEVENT` ioctl.
situations like that.
-
-Return Value
+RETURN VALUE
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 03/54] doc-rst: linux_tv: dvb: use lowercase for filenames
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 01/54] doc-rst: linux_tv: split DVB function call documentation Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 02/54] doc-rst: linux_tv: reformat all syscall pages Mauro Carvalho Chehab
@ 2016-07-08 13:02 ` Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 04/54] doc-rst: linux_tv: dvb: put return value at the end Mauro Carvalho Chehab
` (51 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
There are some ioctls in upper case. This is not the standard.
Put them on lowercase, to match what's done with other ioctls.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
...LEGACY_CMD.rst => fe-dishnetwork-send-legacy-cmd.rst} | 0
.../media/dvb/{FE_GET_EVENT.rst => fe-get-event.rst} | 0
.../dvb/{FE_GET_FRONTEND.rst => fe-get-frontend.rst} | 0
.../media/dvb/{FE_READ_BER.rst => fe-read-ber.rst} | 0
...D_SIGNAL_STRENGTH.rst => fe-read-signal-strength.rst} | 0
.../media/dvb/{FE_READ_SNR.rst => fe-read-snr.rst} | 0
...RRECTED_BLOCKS.rst => fe-read-uncorrected-blocks.rst} | 0
.../dvb/{FE_SET_FRONTEND.rst => fe-set-frontend.rst} | 0
Documentation/linux_tv/media/dvb/frontend_legacy_api.rst | 16 ++++++++--------
9 files changed, 8 insertions(+), 8 deletions(-)
rename Documentation/linux_tv/media/dvb/{FE_DISHNETWORK_SEND_LEGACY_CMD.rst => fe-dishnetwork-send-legacy-cmd.rst} (100%)
rename Documentation/linux_tv/media/dvb/{FE_GET_EVENT.rst => fe-get-event.rst} (100%)
rename Documentation/linux_tv/media/dvb/{FE_GET_FRONTEND.rst => fe-get-frontend.rst} (100%)
rename Documentation/linux_tv/media/dvb/{FE_READ_BER.rst => fe-read-ber.rst} (100%)
rename Documentation/linux_tv/media/dvb/{FE_READ_SIGNAL_STRENGTH.rst => fe-read-signal-strength.rst} (100%)
rename Documentation/linux_tv/media/dvb/{FE_READ_SNR.rst => fe-read-snr.rst} (100%)
rename Documentation/linux_tv/media/dvb/{FE_READ_UNCORRECTED_BLOCKS.rst => fe-read-uncorrected-blocks.rst} (100%)
rename Documentation/linux_tv/media/dvb/{FE_SET_FRONTEND.rst => fe-set-frontend.rst} (100%)
diff --git a/Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst b/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst
rename to Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst b/Documentation/linux_tv/media/dvb/fe-get-event.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
rename to Documentation/linux_tv/media/dvb/fe-get-event.rst
diff --git a/Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/fe-get-frontend.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst
rename to Documentation/linux_tv/media/dvb/fe-get-frontend.rst
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_BER.rst b/Documentation/linux_tv/media/dvb/fe-read-ber.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_READ_BER.rst
rename to Documentation/linux_tv/media/dvb/fe-read-ber.rst
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst b/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
rename to Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst b/Documentation/linux_tv/media/dvb/fe-read-snr.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
rename to Documentation/linux_tv/media/dvb/fe-read-snr.rst
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst b/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst
rename to Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
diff --git a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
similarity index 100%
rename from Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
rename to Documentation/linux_tv/media/dvb/fe-set-frontend.rst
diff --git a/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst b/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst
index fb17766d887e..759833d3eaa4 100644
--- a/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_legacy_api.rst
@@ -28,11 +28,11 @@ recommended
.. toctree::
:maxdepth: 1
- FE_READ_BER
- FE_READ_SNR
- FE_READ_SIGNAL_STRENGTH
- FE_READ_UNCORRECTED_BLOCKS
- FE_SET_FRONTEND
- FE_GET_FRONTEND
- FE_GET_EVENT
- FE_DISHNETWORK_SEND_LEGACY_CMD
+ fe-read-ber
+ fe-read-snr
+ fe-read-signal-strength
+ fe-read-uncorrected-blocks
+ fe-set-frontend
+ fe-get-frontend
+ fe-get-event
+ fe-dishnetwork-send-legacy-cmd
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 04/54] doc-rst: linux_tv: dvb: put return value at the end
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (2 preceding siblings ...)
2016-07-08 13:02 ` [PATCH 03/54] doc-rst: linux_tv: dvb: use lowercase for filenames Mauro Carvalho Chehab
@ 2016-07-08 13:02 ` Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 05/54] doc-rst: boilerplate HTML theme customization Mauro Carvalho Chehab
` (50 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
On some syscall descriptions, the tables are described after
the return value. Do that inside descriptions.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../linux_tv/media/dvb/audio-set-attributes.rst | 2 --
Documentation/linux_tv/media/dvb/audio-set-ext-id.rst | 2 --
.../linux_tv/media/dvb/audio-set-karaoke.rst | 2 --
.../linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst | 19 ++++++++++---------
.../linux_tv/media/dvb/fe-diseqc-send-burst.rst | 17 +++++++----------
Documentation/linux_tv/media/dvb/fe-get-info.rst | 19 ++++++++++---------
Documentation/linux_tv/media/dvb/fe-read-ber.rst | 2 --
Documentation/linux_tv/media/dvb/fe-read-status.rst | 15 +++++++--------
Documentation/linux_tv/media/dvb/fe-set-frontend.rst | 2 --
Documentation/linux_tv/media/dvb/fe-set-tone.rst | 17 +++++++----------
Documentation/linux_tv/media/dvb/video-get-event.rst | 2 --
11 files changed, 41 insertions(+), 58 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
index ea08cea6aa78..820c8b2e2298 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
@@ -58,8 +58,6 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
diff --git a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
index 456b05267f29..38a255289e8c 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
@@ -58,8 +58,6 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
diff --git a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
index 07453ceae40f..28138222582a 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
@@ -57,8 +57,6 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
index 60241c6e68a8..7ddbce6bcd7e 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
@@ -36,17 +36,11 @@ DESCRIPTION
Receives reply from a DiSEqC 2.0 command.
-
-RETURN VALUE
-============
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. _dvb-diseqc-slave-reply:
+struct dvb_diseqc_slave_reply
+-----------------------------
+
.. flat-table:: struct dvb_diseqc_slave_reply
:header-rows: 0
:stub-columns: 0
@@ -78,3 +72,10 @@ appropriately. The generic error codes are described at the
- Return from ioctl after timeout ms with errorcode when no message
was received
+
+RETURN VALUE
+============
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
index dea9cdff0469..806ee5a9df68 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
@@ -40,21 +40,11 @@ read/write permissions.
It provides support for what's specified at
`Digital Satellite Equipment Control (DiSEqC) - Simple "ToneBurst" Detection Circuit specification. <http://www.eutelsat.com/files/contributed/satellites/pdf/Diseqc/associated%20docs/simple_tone_burst_detec.pdf>`__
-
-RETURN VALUE
-============
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. _fe-sec-mini-cmd-t:
enum fe_sec_mini_cmd
====================
-
.. _fe-sec-mini-cmd:
.. flat-table:: enum fe_sec_mini_cmd
@@ -83,3 +73,10 @@ enum fe_sec_mini_cmd
``SEC_MINI_B``
- Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
+
+RETURN VALUE
+============
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/fe-get-info.rst b/Documentation/linux_tv/media/dvb/fe-get-info.rst
index d97218805851..1efb242d7f4a 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-info.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-info.rst
@@ -41,17 +41,11 @@ takes a pointer to dvb_frontend_info which is filled by the driver.
When the driver is not compatible with this specification the ioctl
returns an error.
-
-RETURN VALUE
-============
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. _dvb-frontend-info:
+struct dvb_frontend_info
+========================
+
.. flat-table:: struct dvb_frontend_info
:header-rows: 0
:stub-columns: 0
@@ -423,3 +417,10 @@ supported only on some specific frontend types.
``FE_CAN_MUTE_TS``
- The frontend can stop spurious TS data output
+
+RETURN VALUE
+============
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/fe-read-ber.rst b/Documentation/linux_tv/media/dvb/fe-read-ber.rst
index f0b364baba96..39cf656a4ca0 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-ber.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-ber.rst
@@ -20,8 +20,6 @@ SYNOPSIS
Arguments
----------
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
diff --git a/Documentation/linux_tv/media/dvb/fe-read-status.rst b/Documentation/linux_tv/media/dvb/fe-read-status.rst
index ac6f23869530..697598d30976 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-status.rst
@@ -44,14 +44,6 @@ varies according with the architecture. This needs to be fixed in the
future.
-RETURN VALUE
-============
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. _fe-status-t:
int fe_status
@@ -132,3 +124,10 @@ state changes of the frontend hardware. It is produced using the enum
- The frontend was reinitialized, application is recommended to
reset DiSEqC, tone and parameters
+
+RETURN VALUE
+============
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
index 0cce39666773..06edd97e7e53 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
@@ -66,8 +66,6 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
diff --git a/Documentation/linux_tv/media/dvb/fe-set-tone.rst b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
index afe8b750fca6..18677f205954 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-tone.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
@@ -46,21 +46,11 @@ a tone may interfere on other devices, as they may lose the capability
of selecting the band. So, it is recommended that applications would
change to SEC_TONE_OFF when the device is not used.
-
-RETURN VALUE
-============
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. _fe-sec-tone-mode-t:
enum fe_sec_tone_mode
=====================
-
.. _fe-sec-tone-mode:
.. flat-table:: enum fe_sec_tone_mode
@@ -90,3 +80,10 @@ enum fe_sec_tone_mode
- Don't send a 22kHz tone to the antenna (except if the
FE_DISEQC_* ioctls are called)
+
+RETURN VALUE
+============
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
diff --git a/Documentation/linux_tv/media/dvb/video-get-event.rst b/Documentation/linux_tv/media/dvb/video-get-event.rst
index 3240cd6da6f6..b08ca148ecdc 100644
--- a/Documentation/linux_tv/media/dvb/video-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-event.rst
@@ -69,8 +69,6 @@ On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. flat-table::
:header-rows: 0
:stub-columns: 0
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 05/54] doc-rst: boilerplate HTML theme customization
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (3 preceding siblings ...)
2016-07-08 13:02 ` [PATCH 04/54] doc-rst: linux_tv: dvb: put return value at the end Mauro Carvalho Chehab
@ 2016-07-08 13:02 ` Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 06/54] doc-rst: remove Documentation/linux_tv/conf.py file Mauro Carvalho Chehab
` (49 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
From: Markus Heiser <markus.heiser@darmarIT.de>
Implements the minimal boilerplate for Sphinx HTML theme customization.
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/conf.py | 9 ++++++++-
Documentation/sphinx-static/theme_overrides.css | 9 +++++++++
2 files changed, 17 insertions(+), 1 deletion(-)
create mode 100644 Documentation/sphinx-static/theme_overrides.css
diff --git a/Documentation/conf.py b/Documentation/conf.py
index 792b6338ef19..f35748b4bc26 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -176,7 +176,14 @@ except ImportError:
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-#html_static_path = ['_static']
+
+html_static_path = ['sphinx-static']
+
+html_context = {
+ 'css_files': [
+ '_static/theme_overrides.css',
+ ],
+}
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css
new file mode 100644
index 000000000000..4d670dbf7ffa
--- /dev/null
+++ b/Documentation/sphinx-static/theme_overrides.css
@@ -0,0 +1,9 @@
+/* -*- coding: utf-8; mode: css -*-
+ *
+ * Sphinx HTML theme customization
+ *
+ */
+
+@media screen {
+
+}
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 06/54] doc-rst: remove Documentation/linux_tv/conf.py file
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (4 preceding siblings ...)
2016-07-08 13:02 ` [PATCH 05/54] doc-rst: boilerplate HTML theme customization Mauro Carvalho Chehab
@ 2016-07-08 13:02 ` Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 07/54] doc-rst: customize RTD theme, table & full width Mauro Carvalho Chehab
` (48 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This file is actually not used to build the media uAPI docbook.
So, remove it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/conf.py | 221 -----------------------------------------
1 file changed, 221 deletions(-)
delete mode 100644 Documentation/linux_tv/conf.py
diff --git a/Documentation/linux_tv/conf.py b/Documentation/linux_tv/conf.py
deleted file mode 100644
index ea5f6ef25d6b..000000000000
--- a/Documentation/linux_tv/conf.py
+++ /dev/null
@@ -1,221 +0,0 @@
-# -*- coding: utf-8; mode: python -*-
-#
-# This is the project specific sphinx-build configuration, which is loaded from
-# the base configuration file (``../conf.py``). About config values consult:
-#
-# * http://www.sphinx-doc.org/en/stable/config.html
-#
-# While setting values here, please take care to not overwrite common needed
-# configurations. This means, do not *overwrite* composite values (e.g. the
-# list- or dictionary-value of "latex_elements" resp. "extensions") by
-# thoughtless assignments. Manipulate composite values always by *update*
-# (dict-values) or extend (list-values). Nevertheless, if you know what you are
-# doing, you are free to *overwrite* values to your needs.
-#
-# useful preset names:
-#
-# * BASE_FOLDER: the folder where the top conf.py is located
-# * main_name: the basename of this project-folder
-
-# Set parser's default kernel-doc mode ``reST|kernel-doc``.
-kernel_doc_mode = "kernel-doc"
-
-# ------------------------------------------------------------------------------
-# General configuration
-# ------------------------------------------------------------------------------
-
-project = u'LINUX MEDIA INFRASTRUCTURE API'
-copyright = u'2009-2016 : LinuxTV Developers'
-author = u'The LinuxTV Developers'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-#version = 'v4.7'
-# The full version, including alpha/beta/rc tags.
-#release = 'v4.7-rc2'
-
-# extlinks["man"] = ('http://manpages.ubuntu.com/cgi-bin/search.py?q=%s', ' ')
-
-# intersphinx_mapping['kernel-doc'] = ('http://return42.github.io/sphkerneldoc/books/kernel-doc-HOWTO/', None)
-
-extensions.extend([
- # 'sphinx.ext.pngmath'
- #, 'sphinx.ext.mathjax'
-])
-
-# ------------------------------------------------------------------------------
-# Options for HTML output
-# ------------------------------------------------------------------------------
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = pathjoin(BASE_FOLDER, "_tex", "logo.png")
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path.extend([])
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = main_name
-
-# ------------------------------------------------------------------------------
-# Options for rst2pdf output
-# ------------------------------------------------------------------------------
-
-# Grouping the document tree into PDF files. List of tuples
-# (source start file, target name, title, author, options).
-#
-# The options element is a dictionary that lets you override
-# this config per-document.
-# For example,
-# ('index', u'MyProject', u'My Project', u'Author Name',
-# dict(pdf_compressed = True))
-# would mean that specific document would be compressed
-# regardless of the global pdf_compressed setting.
-#
-# further: http://rst2pdf.ralsina.me/handbook.html#sphinx
-
-# FIXME: at this time, the rst2pdf fails with a bug
-#pdf_documents = [
-# (master_doc, main_name, project, author)
-# , ]
-
-# If false, no index is generated.
-pdf_use_index = False
-
-# How many levels deep should the table of contents be?
-pdf_toc_depth = 3
-
-# Add section number to section references
-pdf_use_numbered_links = False
-
-# Background images fitting mode
-pdf_fit_background_mode = 'scale'
-
-
-# ------------------------------------------------------------------------------
-# Options for manual page output
-# ------------------------------------------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-# man_pages = [
-# (master_doc, 'kernel-doc', u'Kernel-Doc',
-# [author], 1)
-# ]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-# ------------------------------------------------------------------------------
-# Options for Texinfo output
-# ------------------------------------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-# texinfo_documents = [
-# (master_doc, 'Kernel-Doc', u'Kernel-Doc Documentation',
-# author, 'Kernel-Doc', 'One line description of project.',
-# 'Miscellaneous'),
-# ]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
-
-# ------------------------------------------------------------------------------
-# Options for Epub output
-# ------------------------------------------------------------------------------
-
-# Bibliographic Dublin Core info.
-# epub_title = project
-# epub_author = author
-# epub_publisher = author
-# epub_copyright = copyright
-
-# The basename for the epub file. It defaults to the project name.
-#epub_basename = project
-
-# The HTML theme for the epub output. Since the default themes are not
-# optimized for small screen space, using the same theme for HTML and epub
-# output is usually not wise. This defaults to 'epub', a theme designed to save
-# visual space.
-#epub_theme = 'epub'
-
-# The language of the text. It defaults to the language option
-# or 'en' if the language is not set.
-#epub_language = ''
-
-# The scheme of the identifier. Typical schemes are ISBN or URL.
-#epub_scheme = ''
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#epub_identifier = ''
-
-# A unique identification for the text.
-#epub_uid = ''
-
-# A tuple containing the cover image and cover page html template filenames.
-#epub_cover = ()
-
-# A sequence of (type, uri, title) tuples for the guide element of content.opf.
-#epub_guide = ()
-
-# HTML files that should be inserted before the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_pre_files.extend([])
-
-# HTML files that should be inserted after the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#epub_post_files.extend([])
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files.extend([])
-
-# The depth of the table of contents in toc.ncx.
-#epub_tocdepth = 3
-
-# Allow duplicate toc entries.
-#epub_tocdup = True
-
-# Choose between 'default' and 'includehidden'.
-#epub_tocscope = 'default'
-
-# Fix unsupported image types using the Pillow.
-#epub_fix_images = False
-
-# Scale large images.
-#epub_max_image_width = 0
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#epub_show_urls = 'inline'
-
-# If false, no index is generated.
-#epub_use_index = True
-
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 07/54] doc-rst: customize RTD theme, table & full width
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (5 preceding siblings ...)
2016-07-08 13:02 ` [PATCH 06/54] doc-rst: remove Documentation/linux_tv/conf.py file Mauro Carvalho Chehab
@ 2016-07-08 13:02 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 08/54] doc-rst: customize RTD theme, captions & inline literal Mauro Carvalho Chehab
` (47 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:02 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
From: Markus Heiser <markus.heiser@darmarIT.de>
The default table layout of the RTD theme does not fit for vast tables,
like the ones we have in the linux_tv project. This has been discussed
on the ML [1].
The RTD theme is a two column layout, with a navigation column on the
left and a content column on the right:
content column
RTD theme's default is 800px as max width for the content, but we have
tables with tons of columns, which need the full width of the
view-port (BTW: *full width* is what DocBook's HTML is).
table
- sequences of whitespace should collapse into a single whitespace.
- make the overflow auto (scrollbar if needed)
- align caption "left" ("center" is unsuitable on vast tables)
[1] http://article.gmane.org/gmane.linux.kernel/2216509
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/sphinx-static/theme_overrides.css | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css
index 4d670dbf7ffa..ea06799214fd 100644
--- a/Documentation/sphinx-static/theme_overrides.css
+++ b/Documentation/sphinx-static/theme_overrides.css
@@ -1,9 +1,28 @@
/* -*- coding: utf-8; mode: css -*-
*
- * Sphinx HTML theme customization
+ * Sphinx HTML theme customization: read the doc
*
*/
@media screen {
+ /* content column
+ *
+ * RTD theme's default is 800px as max width for the content, but we have
+ * tables with tons of columns, which need the full width of the view-port.
+ */
+
+ .wy-nav-content{max-width: none; }
+
+ /* table:
+ *
+ * - Sequences of whitespace should collapse into a single whitespace.
+ * - make the overflow auto (scrollbar if needed)
+ * - align caption "left" ("center" is unsuitable on vast tables)
+ */
+
+ .wy-table-responsive table td { white-space: normal; }
+ .wy-table-responsive { overflow: auto; }
+ .rst-content table.docutils caption { text-align: left; font-size: 100%; }
+
}
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 08/54] doc-rst: customize RTD theme, captions & inline literal
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (6 preceding siblings ...)
2016-07-08 13:02 ` [PATCH 07/54] doc-rst: customize RTD theme, table & full width Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 09/54] doc-rst: linux_tv: don't use uppercases for syscall sections Mauro Carvalho Chehab
` (46 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
From: Markus Heiser <markus.heiser@darmarIT.de>
The layout of (table) captions in the RTD theme is a bit ugly and the
bordered, red colored of inline literals is a bit to gaudy. The
requirements has been discussed in the ML [1].
captions:
- captions should have 100% (not 85%) font size
- hide the permalink symbol as long as link is not hovered
inline literal:
- drop the borderbox and red color
[1] http://article.gmane.org/gmane.linux.drivers.video-input-infrastructure/101099
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/sphinx-static/theme_overrides.css | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/Documentation/sphinx-static/theme_overrides.css b/Documentation/sphinx-static/theme_overrides.css
index ea06799214fd..c97d8428302d 100644
--- a/Documentation/sphinx-static/theme_overrides.css
+++ b/Documentation/sphinx-static/theme_overrides.css
@@ -25,4 +25,29 @@
.wy-table-responsive { overflow: auto; }
.rst-content table.docutils caption { text-align: left; font-size: 100%; }
+ /* captions:
+ *
+ * - captions should have 100% (not 85%) font size
+ * - hide the permalink symbol as long as link is not hovered
+ */
+
+ caption, .wy-table caption, .rst-content table.field-list caption {
+ font-size: 100%;
+ }
+ caption a.headerlink { opacity: 0; }
+ caption a.headerlink:hover { opacity: 1; }
+
+ /* inline literal: drop the borderbox and red color */
+
+ code, .rst-content tt, .rst-content code {
+ color: inherit;
+ border: none;
+ background: inherit;
+ font-size: 85%;
+ }
+
+ .rst-content tt.literal,.rst-content tt.literal,.rst-content code.literal {
+ color: inherit;
+ }
+
}
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 09/54] doc-rst: linux_tv: don't use uppercases for syscall sections
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (7 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 08/54] doc-rst: customize RTD theme, captions & inline literal Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 10/54] doc-rst: linux_tv: use :cpp:function:: on all syscalls Mauro Carvalho Chehab
` (45 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
On the syscall conversions, we used uppercase for the sections,
but this is too bold. So, convert them to Camel Case, as it
looks visually better.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../media/dvb/audio-bilingual-channel-select.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-channel-select.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-clear-buffer.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-continue.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-fclose.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-fopen.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-fwrite.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-get-capabilities.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-get-pts.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-get-status.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-pause.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-play.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-select-source.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-attributes.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-av-sync.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-bypass-mode.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-ext-id.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-set-id.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-karaoke.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-mixer.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-mute.rst | 11 +++++-----
.../linux_tv/media/dvb/audio-set-streamtype.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/audio-stop.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-fclose.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-fopen.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-get-cap.rst | 11 +++++-----
.../linux_tv/media/dvb/ca-get-descr-info.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-get-msg.rst | 11 +++++-----
.../linux_tv/media/dvb/ca-get-slot-info.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-reset.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-send-msg.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-set-descr.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/ca-set-pid.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-add-pid.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-fclose.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-fopen.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-fread.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-fwrite.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-get-caps.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-get-event.rst | 11 +++++-----
.../linux_tv/media/dvb/dmx-get-pes-pids.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-get-stc.rst | 11 +++++-----
.../linux_tv/media/dvb/dmx-remove-pid.rst | 11 +++++-----
.../linux_tv/media/dvb/dmx-set-buffer-size.rst | 11 +++++-----
.../linux_tv/media/dvb/dmx-set-filter.rst | 11 +++++-----
.../linux_tv/media/dvb/dmx-set-pes-filter.rst | 11 +++++-----
.../linux_tv/media/dvb/dmx-set-source.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-start.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/dmx-stop.rst | 11 +++++-----
.../media/dvb/fe-diseqc-recv-slave-reply.rst | 12 ++++++-----
.../media/dvb/fe-diseqc-reset-overload.rst | 11 +++++-----
.../linux_tv/media/dvb/fe-diseqc-send-burst.rst | 12 ++++++-----
.../media/dvb/fe-diseqc-send-master-cmd.rst | 11 +++++-----
.../media/dvb/fe-dishnetwork-send-legacy-cmd.rst | 11 +++++-----
.../media/dvb/fe-enable-high-lnb-voltage.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/fe-get-event.rst | 11 +++++-----
.../linux_tv/media/dvb/fe-get-frontend.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/fe-get-info.rst | 12 ++++++-----
.../linux_tv/media/dvb/fe-get-property.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/fe-read-ber.rst | 24 ++++++++++++++--------
.../linux_tv/media/dvb/fe-read-signal-strength.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/fe-read-snr.rst | 11 +++++-----
.../linux_tv/media/dvb/fe-read-status.rst | 12 ++++++-----
.../media/dvb/fe-read-uncorrected-blocks.rst | 11 +++++-----
.../media/dvb/fe-set-frontend-tune-mode.rst | 11 +++++-----
.../linux_tv/media/dvb/fe-set-frontend.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/fe-set-tone.rst | 12 ++++++-----
.../linux_tv/media/dvb/fe-set-voltage.rst | 11 +++++-----
.../linux_tv/media/dvb/frontend_f_close.rst | 11 +++++-----
.../linux_tv/media/dvb/frontend_f_open.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/net-add-if.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/net-get-if.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/net-remove-if.rst | 11 +++++-----
.../linux_tv/media/dvb/video-clear-buffer.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-command.rst | 11 +++++-----
.../linux_tv/media/dvb/video-continue.rst | 11 +++++-----
.../linux_tv/media/dvb/video-fast-forward.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-fclose.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-fopen.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-freeze.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-fwrite.rst | 11 +++++-----
.../linux_tv/media/dvb/video-get-capabilities.rst | 11 +++++-----
.../linux_tv/media/dvb/video-get-event.rst | 11 +++++-----
.../linux_tv/media/dvb/video-get-frame-count.rst | 11 +++++-----
.../linux_tv/media/dvb/video-get-frame-rate.rst | 11 +++++-----
.../linux_tv/media/dvb/video-get-navi.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-get-pts.rst | 11 +++++-----
.../linux_tv/media/dvb/video-get-size.rst | 11 +++++-----
.../linux_tv/media/dvb/video-get-status.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-play.rst | 11 +++++-----
.../linux_tv/media/dvb/video-select-source.rst | 11 +++++-----
.../linux_tv/media/dvb/video-set-attributes.rst | 11 +++++-----
.../linux_tv/media/dvb/video-set-blank.rst | 11 +++++-----
.../media/dvb/video-set-display-format.rst | 11 +++++-----
.../linux_tv/media/dvb/video-set-format.rst | 11 +++++-----
.../linux_tv/media/dvb/video-set-highlight.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-set-id.rst | 11 +++++-----
.../linux_tv/media/dvb/video-set-spu-palette.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-set-spu.rst | 11 +++++-----
.../linux_tv/media/dvb/video-set-streamtype.rst | 11 +++++-----
.../linux_tv/media/dvb/video-set-system.rst | 11 +++++-----
.../linux_tv/media/dvb/video-slowmotion.rst | 11 +++++-----
.../linux_tv/media/dvb/video-stillpicture.rst | 11 +++++-----
Documentation/linux_tv/media/dvb/video-stop.rst | 11 +++++-----
.../linux_tv/media/dvb/video-try-command.rst | 11 +++++-----
.../linux_tv/media/mediactl/media-func-close.rst | 11 +++++-----
.../linux_tv/media/mediactl/media-func-ioctl.rst | 11 +++++-----
.../linux_tv/media/mediactl/media-func-open.rst | 11 +++++-----
.../media/mediactl/media-ioc-device-info.rst | 11 +++++-----
.../media/mediactl/media-ioc-enum-entities.rst | 11 +++++-----
.../media/mediactl/media-ioc-enum-links.rst | 11 +++++-----
.../media/mediactl/media-ioc-g-topology.rst | 11 +++++-----
.../media/mediactl/media-ioc-setup-link.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-close.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-ioctl.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-mmap.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-munmap.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-open.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-poll.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-read.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-select.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/func-write.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-create-bufs.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-cropcap.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-dbg-g-register.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-decoder-cmd.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-dqevent.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-encoder-cmd.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enum-dv-timings.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enum-fmt.rst | 11 +++++-----
.../media/v4l/vidioc-enum-frameintervals.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enum-framesizes.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enum-freq-bands.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enumaudio.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enuminput.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enumoutput.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-enumstd.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-audio.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-audioout.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-enc-index.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-ext-ctrls.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-frequency.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-input.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-jpegcomp.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-modulator.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-output.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-priority.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-selection.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-g-std.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-g-tuner.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-log-status.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-overlay.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-prepare-buf.rst | 11 +++++-----
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-query-dv-timings.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-querybuf.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-querycap.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-queryctrl.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-querystd.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-reqbufs.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-streamon.rst | 11 +++++-----
.../v4l/vidioc-subdev-enum-frame-interval.rst | 11 +++++-----
.../media/v4l/vidioc-subdev-enum-frame-size.rst | 11 +++++-----
.../media/v4l/vidioc-subdev-enum-mbus-code.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-subdev-g-crop.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-subdev-g-fmt.rst | 11 +++++-----
.../media/v4l/vidioc-subdev-g-frame-interval.rst | 11 +++++-----
.../media/v4l/vidioc-subdev-g-selection.rst | 11 +++++-----
.../linux_tv/media/v4l/vidioc-subscribe-event.rst | 11 +++++-----
182 files changed, 1107 insertions(+), 913 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
index dda1695e28a9..841c9759d5e0 100644
--- a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
+++ b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
@@ -6,18 +6,19 @@
AUDIO_BILINGUAL_CHANNEL_SELECT
==============================
-NAME
+Name
----
AUDIO_BILINGUAL_CHANNEL_SELECT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Select the output format of the audio (mono left/right, stereo).
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. It has been replaced
@@ -55,7 +56,7 @@ This ioctl call asks the Audio Device to select the requested channel
for bilingual streams if possible.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
index f7f9766d3902..f2dd79903c49 100644
--- a/Documentation/linux_tv/media/dvb/audio-channel-select.rst
+++ b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
@@ -6,18 +6,19 @@
AUDIO_CHANNEL_SELECT
====================
-NAME
+Name
----
AUDIO_CHANNEL_SELECT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Select the output format of the audio (mono left/right, stereo).
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
@@ -54,7 +55,7 @@ This ioctl call asks the Audio Device to select the requested channel if
possible.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
index 97cb3d98f20d..a576c6b160a4 100644
--- a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
+++ b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
@@ -6,18 +6,19 @@
AUDIO_CLEAR_BUFFER
==================
-NAME
+Name
----
AUDIO_CLEAR_BUFFER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_CLEAR_BUFFER for this command.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to clear all software and hardware
buffers of the audio decoder device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-continue.rst b/Documentation/linux_tv/media/dvb/audio-continue.rst
index 1f3d5c35b7ce..b513a39f0935 100644
--- a/Documentation/linux_tv/media/dvb/audio-continue.rst
+++ b/Documentation/linux_tv/media/dvb/audio-continue.rst
@@ -6,18 +6,19 @@
AUDIO_CONTINUE
==============
-NAME
+Name
----
AUDIO_CONTINUE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_CONTINUE for this command.
-DESCRIPTION
+Description
-----------
This ioctl restarts the decoding and playing process previously paused
with AUDIO_PAUSE command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-fclose.rst b/Documentation/linux_tv/media/dvb/audio-fclose.rst
index 80d9cde4c926..e515fb353a14 100644
--- a/Documentation/linux_tv/media/dvb/audio-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fclose.rst
@@ -6,18 +6,19 @@
DVB audio close()
=================
-NAME
+Name
----
DVB audio close()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -32,13 +33,13 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call closes a previously opened audio device.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/audio-fopen.rst b/Documentation/linux_tv/media/dvb/audio-fopen.rst
index 6596d6427c1f..46a15950439f 100644
--- a/Documentation/linux_tv/media/dvb/audio-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fopen.rst
@@ -6,18 +6,19 @@
DVB audio open()
================
-NAME
+Name
----
DVB audio open()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call opens a named audio device (e.g.
@@ -76,7 +77,7 @@ in O_RDONLY mode, the only ioctl call that can be used is
AUDIO_GET_STATUS. All other call will return with an error code.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/audio-fwrite.rst b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
index 9aa9583a3267..f9307053064f 100644
--- a/Documentation/linux_tv/media/dvb/audio-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
@@ -6,18 +6,19 @@
DVB audio write()
=================
-NAME
+Name
----
DVB audio write()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call can only be used if AUDIO_SOURCE_MEMORY is selected
@@ -54,7 +55,7 @@ until buffer space is available. The amount of data to be transferred is
implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
index 32e55bbc4d03..8b6fdc664f9d 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
@@ -6,18 +6,19 @@
AUDIO_GET_CAPABILITIES
======================
-NAME
+Name
----
AUDIO_GET_CAPABILITIES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- Returns a bit array of supported sound formats.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to tell us about the decoding
capabilities of the audio hardware.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-get-pts.rst b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
index a8e2ef5a107d..246c78c003de 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-pts.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
@@ -6,18 +6,19 @@
AUDIO_GET_PTS
=============
-NAME
+Name
----
AUDIO_GET_PTS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -49,7 +50,7 @@ ARGUMENTS
decoded frame or the last PTS extracted by the PES parser.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. If you need this
@@ -60,7 +61,7 @@ This ioctl call asks the Audio Device to return the current PTS
timestamp.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-get-status.rst b/Documentation/linux_tv/media/dvb/audio-get-status.rst
index b9a2850b577a..b0a550af87b3 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-status.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-status.rst
@@ -6,18 +6,19 @@
AUDIO_GET_STATUS
================
-NAME
+Name
----
AUDIO_GET_STATUS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- Returns the current state of Audio Device.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to return the current state of the
Audio Device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-pause.rst b/Documentation/linux_tv/media/dvb/audio-pause.rst
index 8b1517b54272..86652c3bca06 100644
--- a/Documentation/linux_tv/media/dvb/audio-pause.rst
+++ b/Documentation/linux_tv/media/dvb/audio-pause.rst
@@ -6,18 +6,19 @@
AUDIO_PAUSE
===========
-NAME
+Name
----
AUDIO_PAUSE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,7 +39,7 @@ ARGUMENTS
- Equals AUDIO_PAUSE for this command.
-DESCRIPTION
+Description
-----------
This ioctl call suspends the audio stream being played. Decoding and
@@ -46,7 +47,7 @@ playing are paused. It is then possible to restart again decoding and
playing process of the audio stream using AUDIO_CONTINUE command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-play.rst b/Documentation/linux_tv/media/dvb/audio-play.rst
index 22bd35007b25..1af708375821 100644
--- a/Documentation/linux_tv/media/dvb/audio-play.rst
+++ b/Documentation/linux_tv/media/dvb/audio-play.rst
@@ -6,18 +6,19 @@
AUDIO_PLAY
==========
-NAME
+Name
----
AUDIO_PLAY
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_PLAY for this command.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to start playing an audio stream
from the selected source.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-select-source.rst b/Documentation/linux_tv/media/dvb/audio-select-source.rst
index 2242e6f0b6ad..3e873d9cb345 100644
--- a/Documentation/linux_tv/media/dvb/audio-select-source.rst
+++ b/Documentation/linux_tv/media/dvb/audio-select-source.rst
@@ -6,18 +6,19 @@
AUDIO_SELECT_SOURCE
===================
-NAME
+Name
----
AUDIO_SELECT_SOURCE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Indicates the source that shall be used for the Audio stream.
-DESCRIPTION
+Description
-----------
This ioctl call informs the audio device which source shall be used for
@@ -53,7 +54,7 @@ AUDIO_SOURCE_MEMORY is selected, the data is fed to the Audio Device
through the write command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
index 820c8b2e2298..43ff50279742 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
@@ -6,18 +6,19 @@
AUDIO_SET_ATTRIBUTES
====================
-NAME
+Name
----
AUDIO_SET_ATTRIBUTES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- audio attributes according to section ??
-DESCRIPTION
+Description
-----------
This ioctl is intended for DVD playback and allows you to set certain
information about the audio stream.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
index 3f5ac9a87bc8..4ecfb75d28f1 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
@@ -6,18 +6,19 @@
AUDIO_SET_AV_SYNC
=================
-NAME
+Name
----
AUDIO_SET_AV_SYNC
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -54,14 +55,14 @@ ARGUMENTS
- FALSE AV-sync OFF
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to turn ON or OFF A/V
synchronization.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
index 9377342c646d..b21d142ec31c 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
@@ -6,18 +6,19 @@
AUDIO_SET_BYPASS_MODE
=====================
-NAME
+Name
----
AUDIO_SET_BYPASS_MODE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -55,7 +56,7 @@ ARGUMENTS
- FALSE Bypass is enabled
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to bypass the Audio decoder and
@@ -65,7 +66,7 @@ DigitalTM streams are automatically forwarded by the DVB subsystem if
the hardware can handle it.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
index 38a255289e8c..1b5b8893a00b 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
@@ -6,18 +6,19 @@
AUDIO_SET_EXT_ID
================
-NAME
+Name
----
AUDIO_SET_EXT_ID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- audio sub_stream_id
-DESCRIPTION
+Description
-----------
This ioctl can be used to set the extension id for MPEG streams in DVD
playback. Only the first 3 bits are recognized.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-id.rst b/Documentation/linux_tv/media/dvb/audio-set-id.rst
index 60eeee07d244..fed99eae52cb 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-id.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-id.rst
@@ -6,18 +6,19 @@
AUDIO_SET_ID
============
-NAME
+Name
----
AUDIO_SET_ID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- audio sub-stream id
-DESCRIPTION
+Description
-----------
This ioctl selects which sub-stream is to be decoded if a program or
@@ -56,7 +57,7 @@ substream id of the audio stream and only the first 5 bits are
recognized.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
index 28138222582a..ebb2d41bbec3 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
@@ -6,18 +6,19 @@
AUDIO_SET_KARAOKE
=================
-NAME
+Name
----
AUDIO_SET_KARAOKE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- karaoke settings according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl allows one to set the mixer settings for a karaoke DVD.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
index 8d5a6f375419..ce4b2a63917e 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
@@ -6,18 +6,19 @@
AUDIO_SET_MIXER
===============
-NAME
+Name
----
AUDIO_SET_MIXER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- mixer settings.
-DESCRIPTION
+Description
-----------
This ioctl lets you adjust the mixer settings of the audio decoder.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mute.rst b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
index a002d0d7128d..a2469267508b 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-mute.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
@@ -6,18 +6,19 @@
AUDIO_SET_MUTE
==============
-NAME
+Name
----
AUDIO_SET_MUTE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -54,7 +55,7 @@ ARGUMENTS
- FALSE Audio Un-mute
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
@@ -65,7 +66,7 @@ This ioctl call asks the audio device to mute the stream that is
currently being played.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
index a971d43e01cc..4b13c9b9dffe 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
@@ -6,18 +6,19 @@
AUDIO_SET_STREAMTYPE
====================
-NAME
+Name
----
AUDIO_SET_STREAMTYPE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- stream type
-DESCRIPTION
+Description
-----------
This ioctl tells the driver which kind of audio stream to expect. This
@@ -52,7 +53,7 @@ is useful if the stream offers several audio sub-streams like LPCM and
AC3.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/audio-stop.rst b/Documentation/linux_tv/media/dvb/audio-stop.rst
index 558ff2b1effb..d9430978096f 100644
--- a/Documentation/linux_tv/media/dvb/audio-stop.rst
+++ b/Documentation/linux_tv/media/dvb/audio-stop.rst
@@ -6,18 +6,19 @@
AUDIO_STOP
==========
-NAME
+Name
----
AUDIO_STOP
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,14 +39,14 @@ ARGUMENTS
- Equals AUDIO_STOP for this command.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Audio Device to stop playing the current
stream.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-fclose.rst b/Documentation/linux_tv/media/dvb/ca-fclose.rst
index a093e8dd3182..16d7a1e76193 100644
--- a/Documentation/linux_tv/media/dvb/ca-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/ca-fclose.rst
@@ -6,18 +6,19 @@
DVB CA close()
==============
-NAME
+Name
----
DVB CA close()
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -32,13 +33,13 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call closes a previously opened audio device.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/ca-fopen.rst b/Documentation/linux_tv/media/dvb/ca-fopen.rst
index a9bf45a921e9..f284461cce20 100644
--- a/Documentation/linux_tv/media/dvb/ca-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/ca-fopen.rst
@@ -6,18 +6,19 @@
DVB CA open()
=============
-NAME
+Name
----
DVB CA open()
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call opens a named ca device (e.g. /dev/ost/ca) for
@@ -75,7 +76,7 @@ user can open the CA Device in O_RDWR mode. All other attempts to open
the device in this mode will fail, and an error code will be returned.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/ca-get-cap.rst b/Documentation/linux_tv/media/dvb/ca-get-cap.rst
index b026d4769730..891fbf2d9a84 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-cap.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-cap.rst
@@ -6,18 +6,19 @@
CA_GET_CAP
==========
-NAME
+Name
----
CA_GET_CAP
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_CAP, ca_caps_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
index 446afe89af82..cf8e8242db66 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-descr-info.rst
@@ -6,18 +6,19 @@
CA_GET_DESCR_INFO
=================
-NAME
+Name
----
CA_GET_DESCR_INFO
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_DESCR_INFO, ca_descr_info_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-get-msg.rst b/Documentation/linux_tv/media/dvb/ca-get-msg.rst
index 44c944a700c0..56004d5ea3ab 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-msg.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-msg.rst
@@ -6,18 +6,19 @@
CA_GET_MSG
==========
-NAME
+Name
----
CA_GET_MSG
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
index e1e580341dad..9fea28ccad0f 100644
--- a/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
+++ b/Documentation/linux_tv/media/dvb/ca-get-slot-info.rst
@@ -6,18 +6,19 @@
CA_GET_SLOT_INFO
================
-NAME
+Name
----
CA_GET_SLOT_INFO
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_GET_SLOT_INFO, ca_slot_info_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-reset.rst b/Documentation/linux_tv/media/dvb/ca-reset.rst
index ff58c62fb0a5..d5a50088fc2d 100644
--- a/Documentation/linux_tv/media/dvb/ca-reset.rst
+++ b/Documentation/linux_tv/media/dvb/ca-reset.rst
@@ -6,18 +6,19 @@
CA_RESET
========
-NAME
+Name
----
CA_RESET
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_RESET)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,13 +39,13 @@ ARGUMENTS
- Equals CA_RESET for this command.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-send-msg.rst b/Documentation/linux_tv/media/dvb/ca-send-msg.rst
index 9d9b8d2520c1..18974e61e788 100644
--- a/Documentation/linux_tv/media/dvb/ca-send-msg.rst
+++ b/Documentation/linux_tv/media/dvb/ca-send-msg.rst
@@ -6,18 +6,19 @@
CA_SEND_MSG
===========
-NAME
+Name
----
CA_SEND_MSG
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-set-descr.rst b/Documentation/linux_tv/media/dvb/ca-set-descr.rst
index e992dd52432d..293e6da5059f 100644
--- a/Documentation/linux_tv/media/dvb/ca-set-descr.rst
+++ b/Documentation/linux_tv/media/dvb/ca-set-descr.rst
@@ -6,18 +6,19 @@
CA_SET_DESCR
============
-NAME
+Name
----
CA_SET_DESCR
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_DESCR, ca_descr_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/ca-set-pid.rst b/Documentation/linux_tv/media/dvb/ca-set-pid.rst
index e7e3891fa65e..5afa2fae3206 100644
--- a/Documentation/linux_tv/media/dvb/ca-set-pid.rst
+++ b/Documentation/linux_tv/media/dvb/ca-set-pid.rst
@@ -6,18 +6,19 @@
CA_SET_PID
==========
-NAME
+Name
----
CA_SET_PID
-SYNOPSIS
+
+Synopsis
--------
.. cpp:function:: int ioctl(fd, int request = CA_SET_PID, ca_pid_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
index 36bca4f9317c..37f5ee43d523 100644
--- a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
@@ -6,18 +6,19 @@
DMX_ADD_PID
===========
-NAME
+Name
----
DMX_ADD_PID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- PID number to be filtered.
-DESCRIPTION
+Description
-----------
This ioctl call allows to add multiple PIDs to a transport stream filter
@@ -52,7 +53,7 @@ previously set up with DMX_SET_PES_FILTER and output equal to
DMX_OUT_TSDEMUX_TAP.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-fclose.rst b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
index 7889d0b76f7d..e442881481a2 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
@@ -6,18 +6,19 @@
DVB demux close()
=================
-NAME
+Name
----
DVB demux close()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -32,14 +33,14 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call deactivates and deallocates a filter that was
previously allocated via the open() call.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/dmx-fopen.rst b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
index 1e1dbc57c64d..7e640fa860c3 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
@@ -6,18 +6,19 @@
DVB demux open()
================
-NAME
+Name
----
DVB demux open()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -53,7 +54,7 @@ ARGUMENTS
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call, used with a device name of /dev/dvb/adapter0/demux0,
@@ -74,7 +75,7 @@ blocking mode can later be put into non-blocking mode (and vice versa)
using the F_SETFL command of the fcntl system call.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/dmx-fread.rst b/Documentation/linux_tv/media/dvb/dmx-fread.rst
index 55d9bc7f424d..92f7a0632766 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fread.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fread.rst
@@ -6,18 +6,19 @@
DVB demux read()
================
-NAME
+Name
----
DVB demux read()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: size_t read(int fd, void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call returns filtered data, which might be section or PES
@@ -53,7 +54,7 @@ circular buffer to buf. The maximum amount of data to be transferred is
implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
index f39743684966..8d2632205c29 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
@@ -6,18 +6,19 @@
DVB demux write()
=================
-NAME
+Name
----
DVB demux write()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call is only provided by the logical device
@@ -55,7 +56,7 @@ in the corresponding physical demux device, /dev/dvb/adapter0/demux0.
The amount of data to be transferred is implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
index 8c8ae48a93da..20e3d6e55d30 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
@@ -6,18 +6,19 @@
DMX_GET_CAPS
============
-NAME
+Name
----
DMX_GET_CAPS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-event.rst b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
index ab2ab2ed3bed..81a7c7fedd47 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
@@ -6,18 +6,19 @@
DMX_GET_EVENT
=============
-NAME
+Name
----
DMX_GET_EVENT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to the location where the event is to be stored.
-DESCRIPTION
+Description
-----------
This ioctl call returns an event if available. If an event is not
@@ -54,7 +55,7 @@ errno set to ``EWOULDBLOCK``. In the former case, the call blocks until an
event becomes available.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
index cf0d8a6463fb..8b1fbf5d2c81 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
@@ -6,18 +6,19 @@
DMX_GET_PES_PIDS
================
-NAME
+Name
----
DMX_GET_PES_PIDS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
index 35dd691dee09..616c745a0418 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
@@ -6,18 +6,19 @@
DMX_GET_STC
===========
-NAME
+Name
----
DMX_GET_STC
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to the location where the stc is to be stored.
-DESCRIPTION
+Description
-----------
This ioctl call returns the current value of the system time counter
@@ -55,7 +56,7 @@ in form of a ratio with a 64 bit numerator and a 32 bit denominator, so
the real 90kHz STC value is stc->stc / stc->base .
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
index 859e1a14de54..ed1a49ce9fc2 100644
--- a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
@@ -6,18 +6,19 @@
DMX_REMOVE_PID
==============
-NAME
+Name
----
DMX_REMOVE_PID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- PID of the PES filter to be removed.
-DESCRIPTION
+Description
-----------
This ioctl call allows to remove a PID when multiple PIDs are set on a
@@ -53,7 +54,7 @@ equal to DMX_OUT_TSDEMUX_TAP, created via either
DMX_SET_PES_FILTER or DMX_ADD_PID.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
index cf6b32f4e361..012b9e9792be 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
@@ -6,18 +6,19 @@
DMX_SET_BUFFER_SIZE
===================
-NAME
+Name
----
DMX_SET_BUFFER_SIZE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Size of circular buffer.
-DESCRIPTION
+Description
-----------
This ioctl call is used to set the size of the circular buffer used for
@@ -53,7 +54,7 @@ this function is not called a buffer size of 2 \* 4096 bytes will be
used.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
index 0aad102f3151..d079d8b39597 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
@@ -6,18 +6,19 @@
DMX_SET_FILTER
==============
-NAME
+Name
----
DMX_SET_FILTER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to structure containing filter parameters.
-DESCRIPTION
+Description
-----------
This ioctl call sets up a filter according to the filter and mask
@@ -59,7 +60,7 @@ DMX_START ioctl call). If a filter was previously set-up, this filter
will be canceled, and the receive buffer will be flushed.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
index 3dccd7cd0a64..910869ebdefd 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
@@ -6,18 +6,19 @@
DMX_SET_PES_FILTER
==================
-NAME
+Name
----
DMX_SET_PES_FILTER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to structure containing filter parameters.
-DESCRIPTION
+Description
-----------
This ioctl call sets up a PES filter according to the parameters
@@ -53,7 +54,7 @@ packet identifier (PID), i.e. no PES header or payload filtering
capability is supported.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-source.rst b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
index 13045327857f..7aa4dfe3cdc5 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-source.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
@@ -6,18 +6,19 @@
DMX_SET_SOURCE
==============
-NAME
+Name
----
DMX_SET_SOURCE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Undocumented.
-DESCRIPTION
+Description
-----------
This ioctl is undocumented. Documentation is welcome.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-start.rst b/Documentation/linux_tv/media/dvb/dmx-start.rst
index c62e2ad17a6a..cc316d00343d 100644
--- a/Documentation/linux_tv/media/dvb/dmx-start.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-start.rst
@@ -6,18 +6,19 @@
DMX_START
=========
-NAME
+Name
----
DMX_START
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_START)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,14 +39,14 @@ ARGUMENTS
- Equals DMX_START for this command.
-DESCRIPTION
+Description
-----------
This ioctl call is used to start the actual filtering operation defined
via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/dmx-stop.rst b/Documentation/linux_tv/media/dvb/dmx-stop.rst
index ff9df400f71f..f9157dd6a8fe 100644
--- a/Documentation/linux_tv/media/dvb/dmx-stop.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-stop.rst
@@ -6,18 +6,19 @@
DMX_STOP
========
-NAME
+Name
----
DMX_STOP
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl( int fd, int request = DMX_STOP)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,7 +39,7 @@ ARGUMENTS
- Equals DMX_STOP for this command.
-DESCRIPTION
+Description
-----------
This ioctl call is used to stop the actual filtering operation defined
@@ -46,7 +47,7 @@ via the ioctl calls DMX_SET_FILTER or DMX_SET_PES_FILTER and
started via the DMX_START command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
index 7ddbce6bcd7e..7bd02ac7bff4 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst
@@ -6,18 +6,19 @@
ioctl FE_DISEQC_RECV_SLAVE_REPLY
********************************
-NAME
+Name
====
FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_slave_reply *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`dvb_diseqc_slave_reply <dvb-diseqc-slave-reply>`
-DESCRIPTION
+Description
===========
Receives reply from a DiSEqC 2.0 command.
@@ -73,7 +74,8 @@ struct dvb_diseqc_slave_reply
- Return from ioctl after timeout ms with errorcode when no message
was received
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
index 236c25c9f7bd..cab157054c13 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst
@@ -6,18 +6,19 @@
ioctl FE_DISEQC_RESET_OVERLOAD
******************************
-NAME
+Name
====
FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it was powered off due - to power overload.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, NULL )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -27,7 +28,7 @@ ARGUMENTS
FE_DISEQC_RESET_OVERLOAD
-DESCRIPTION
+Description
===========
If the bus has been automatically powered off due to power overload,
@@ -36,7 +37,7 @@ read/write access to the device. This call has no effect if the device
is manually powered off. Not all DVB adapters support this ioctl.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
index 806ee5a9df68..c022cc290067 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
@@ -6,18 +6,19 @@
ioctl FE_DISEQC_SEND_BURST
**************************
-NAME
+Name
====
FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection.
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
pointer to enum :ref:`fe_sec_mini_cmd <fe-sec-mini-cmd>`
-DESCRIPTION
+Description
===========
This ioctl is used to set the generation of a 22kHz tone burst for mini
@@ -74,7 +75,8 @@ enum fe_sec_mini_cmd
- Sends a mini-DiSEqC 22kHz '1' Data Burst to select satellite-B
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
index 519e91bd47fd..dc83b4f2e586 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
@@ -6,18 +6,19 @@
ioctl FE_DISEQC_SEND_MASTER_CMD
*******************************
-NAME
+Name
====
FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_diseqc_master_cmd *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,13 +32,13 @@ ARGUMENTS
:ref:`dvb_diseqc_master_cmd <dvb-diseqc-master-cmd>`
-DESCRIPTION
+Description
===========
Sends a DiSEqC command to the antenna subsystem.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst b/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
index 9435f45f58c3..4b60a42dd52c 100644
--- a/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
+++ b/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
@@ -6,18 +6,19 @@
FE_DISHNETWORK_SEND_LEGACY_CMD
******************************
-NAME
+Name
====
FE_DISHNETWORK_SEND_LEGACY_CMD
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
-ARGUMENTS
+Arguments
=========
.. flat-table::
@@ -32,7 +33,7 @@ ARGUMENTS
- sends the specified raw cmd to the dish via DISEqC.
-DESCRIPTION
+Description
===========
WARNING: This is a very obscure legacy command, used only at stv0299
@@ -45,7 +46,7 @@ As support for this ioctl were added in 2004, this means that such
dishes were already legacy in 2004.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
index 27f49823e67d..de99bf5fbf0e 100644
--- a/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst
@@ -6,18 +6,19 @@
ioctl FE_ENABLE_HIGH_LNB_VOLTAGE
********************************
-NAME
+Name
====
FE_ENABLE_HIGH_LNB_VOLTAGE - Select output DC level between normal LNBf voltages or higher LNBf - voltages.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int high )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -35,7 +36,7 @@ ARGUMENTS
to compensate for long antenna cables.
-DESCRIPTION
+Description
===========
Select output DC level between normal LNBf voltages or higher LNBf
@@ -43,7 +44,7 @@ voltages between 0 (normal) or a value grater than 0 for higher
voltages.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-get-event.rst b/Documentation/linux_tv/media/dvb/fe-get-event.rst
index 3d858107b6f9..79beb1b9da3b 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-event.rst
@@ -6,18 +6,19 @@
FE_GET_EVENT
************
-NAME
+Name
====
FE_GET_EVENT
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
-ARGUMENTS
+Arguments
=========
.. flat-table::
@@ -49,7 +50,7 @@ ARGUMENTS
- if any, is to be stored.
-DESCRIPTION
+Description
===========
This ioctl call returns a frontend event if available. If an event is
@@ -59,7 +60,7 @@ with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
an event becomes available.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-get-frontend.rst b/Documentation/linux_tv/media/dvb/fe-get-frontend.rst
index 7084070bfe77..fdf0d1440add 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-frontend.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-frontend.rst
@@ -6,18 +6,19 @@
FE_GET_FRONTEND
***************
-NAME
+Name
====
FE_GET_FRONTEND
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
-ARGUMENTS
+Arguments
=========
.. flat-table::
@@ -45,14 +46,14 @@ ARGUMENTS
- Points to parameters for tuning operation.
-DESCRIPTION
+Description
===========
This ioctl call queries the currently effective frontend parameters. For
this command, read-only access to the device is sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-get-info.rst b/Documentation/linux_tv/media/dvb/fe-get-info.rst
index 1efb242d7f4a..8ef1ed7bbf68 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-info.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-info.rst
@@ -6,18 +6,19 @@
ioctl FE_GET_INFO
*****************
-NAME
+Name
====
FE_GET_INFO - Query DVB frontend capabilities and returns information about the - front-end. This call only requires read-only access to the device
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_frontend_info *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`dvb_frontend_info <dvb-frontend-info>`
-DESCRIPTION
+Description
===========
All DVB frontend devices support the ``FE_GET_INFO`` ioctl. It is used
@@ -418,7 +419,8 @@ supported only on some specific frontend types.
- The frontend can stop spurious TS data output
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-get-property.rst b/Documentation/linux_tv/media/dvb/fe-get-property.rst
index c470105dcd15..749daafe6b21 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-property.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-property.rst
@@ -6,18 +6,19 @@
ioctl FE_SET_PROPERTY, FE_GET_PROPERTY
**************************************
-NAME
+Name
====
FE_SET_PROPERTY - FE_GET_PROPERTY - FE_SET_PROPERTY sets one or more frontend properties. - FE_GET_PROPERTY returns one or more frontend properties.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dtv_properties *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
pointer to struct :ref:`dtv_properties <dtv-properties>`
-DESCRIPTION
+Description
===========
All DVB frontend devices support the ``FE_SET_PROPERTY`` and
@@ -59,7 +60,7 @@ depends on the delivery system and on the device:
- This call only requires read-only access to the device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-read-ber.rst b/Documentation/linux_tv/media/dvb/fe-read-ber.rst
index 39cf656a4ca0..3262441385ff 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-ber.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-ber.rst
@@ -6,19 +6,19 @@
FE_READ_BER
***********
-Description
------------
+Name
+====
-This ioctl call returns the bit error rate for the signal currently
-received/demodulated by the front-end. For this command, read-only
-access to the device is sufficient.
+FE_READ_BER
-SYNOPSIS
+Synopsis
+========
.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
+
Arguments
-----------
+=========
.. flat-table::
:header-rows: 0
@@ -44,8 +44,16 @@ Arguments
- The bit error rate is stored into \*ber.
+Description
+===========
+
+This ioctl call returns the bit error rate for the signal currently
+received/demodulated by the front-end. For this command, read-only
+access to the device is sufficient.
+
+
Return Value
-------------
+============
On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the
diff --git a/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst b/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
index 7f6f47f4d30e..fcaadcb537fb 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
@@ -6,18 +6,19 @@
FE_READ_SIGNAL_STRENGTH
***********************
-NAME
+Name
====
FE_READ_SIGNAL_STRENGTH
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
-ARGUMENTS
+Arguments
=========
.. flat-table::
@@ -46,7 +47,7 @@ ARGUMENTS
- The signal strength value is stored into \*strength.
-DESCRIPTION
+Description
===========
This ioctl call returns the signal strength value for the signal
@@ -54,7 +55,7 @@ currently received by the front-end. For this command, read-only access
to the device is sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-read-snr.rst b/Documentation/linux_tv/media/dvb/fe-read-snr.rst
index 3ecaeb8007f4..837af2de9f6f 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-snr.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-snr.rst
@@ -6,18 +6,19 @@
FE_READ_SNR
***********
-NAME
+Name
====
FE_READ_SNR
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
-ARGUMENTS
+Arguments
=========
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- The signal-to-noise ratio is stored into \*snr.
-DESCRIPTION
+Description
===========
This ioctl call returns the signal-to-noise ratio for the signal
@@ -52,7 +53,7 @@ currently received by the front-end. For this command, read-only access
to the device is sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-read-status.rst b/Documentation/linux_tv/media/dvb/fe-read-status.rst
index 697598d30976..544ce49ee091 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-status.rst
@@ -6,18 +6,19 @@
ioctl FE_READ_STATUS
********************
-NAME
+Name
====
FE_READ_STATUS - Returns status information about the front-end. This call only requires - read-only access to the device
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int *status )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
:ref:`fe_status <fe-status>`.
-DESCRIPTION
+Description
===========
All DVB frontend devices support the ``FE_READ_STATUS`` ioctl. It is
@@ -125,7 +126,8 @@ state changes of the frontend hardware. It is produced using the enum
- The frontend was reinitialized, application is recommended to
reset DiSEqC, tone and parameters
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst b/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
index 31ec4c35dd51..6b753846a008 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
@@ -6,18 +6,19 @@
FE_READ_UNCORRECTED_BLOCKS
**************************
-NAME
+Name
====
FE_READ_UNCORRECTED_BLOCKS
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
-ARGUMENTS
+Arguments
=========
.. flat-table::
@@ -46,7 +47,7 @@ ARGUMENTS
- The total number of uncorrected blocks seen by the driver so far.
-DESCRIPTION
+Description
===========
This ioctl call returns the number of uncorrected blocks detected by the
@@ -56,7 +57,7 @@ calculated. For this command, read-only access to the device is
sufficient.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
index 1db22c426b8c..411abcf4de58 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst
@@ -6,18 +6,19 @@
ioctl FE_SET_FRONTEND_TUNE_MODE
*******************************
-NAME
+Name
====
FE_SET_FRONTEND_TUNE_MODE - Allow setting tuner mode flags to the frontend.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, unsigned int flags )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -39,14 +40,14 @@ ARGUMENTS
device is reopened read-write.
-DESCRIPTION
+Description
===========
Allow setting tuner mode flags to the frontend, between 0 (normal) or
FE_TUNE_MODE_ONESHOT mode
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
index 06edd97e7e53..4e66da0af6fd 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
@@ -6,18 +6,19 @@
FE_SET_FRONTEND
***************
-NAME
+Name
====
FE_SET_FRONTEND
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
-ARGUMENTS
+Arguments
=========
.. flat-table::
@@ -45,7 +46,7 @@ ARGUMENTS
- Points to parameters for tuning operation.
-DESCRIPTION
+Description
===========
This ioctl call starts a tuning operation using specified parameters.
@@ -59,7 +60,7 @@ previous operation will be aborted in favor of the new one. This command
requires read/write access to the device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-set-tone.rst b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
index 18677f205954..12aedb69395d 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-tone.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
@@ -6,18 +6,19 @@
ioctl FE_SET_TONE
*****************
-NAME
+Name
====
FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_tone_mode *tone )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
pointer to enum :ref:`fe_sec_tone_mode <fe-sec-tone-mode>`
-DESCRIPTION
+Description
===========
This ioctl is used to set the generation of the continuous 22kHz tone.
@@ -81,7 +82,8 @@ enum fe_sec_tone_mode
- Don't send a 22kHz tone to the antenna (except if the
FE_DISEQC_* ioctls are called)
-RETURN VALUE
+
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
index 4fd30ee53f5b..ec8dbf4e266c 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
@@ -6,18 +6,19 @@
ioctl FE_SET_VOLTAGE
********************
-NAME
+Name
====
FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem.
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -33,7 +34,7 @@ ARGUMENTS
:ref:`fe_sec_voltage <fe-sec-voltage>`.
-DESCRIPTION
+Description
===========
This ioctl allows to set the DC voltage level sent through the antenna
@@ -54,7 +55,7 @@ the voltage to SEC_VOLTAGE_OFF while the device is not is used is
recommended.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_close.rst b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
index 7946673d071a..5cce9262084c 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_close.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_close.rst
@@ -6,12 +6,13 @@
DVB frontend close()
********************
-NAME
+Name
====
fe-close - Close a frontend device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,14 +23,14 @@ SYNOPSIS
.. cpp:function:: int close( int fd )
-ARGUMENTS
+Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-DESCRIPTION
+Description
===========
This system call closes a previously opened front-end device. After
@@ -37,7 +38,7 @@ closing a front-end device, its corresponding hardware might be powered
down automatically.
-RETURN VALUE
+Return Value
============
The function returns 0 on success, -1 on failure and the ``errno`` is
diff --git a/Documentation/linux_tv/media/dvb/frontend_f_open.rst b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
index 97ca34b94d05..e0c55345f524 100644
--- a/Documentation/linux_tv/media/dvb/frontend_f_open.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_f_open.rst
@@ -6,12 +6,13 @@
DVB frontend open()
*******************
-NAME
+Name
====
fe-open - Open a frontend device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int open( const char *device_name, int flags )
-ARGUMENTS
+Arguments
=========
``device_name``
@@ -44,7 +45,7 @@ ARGUMENTS
Other flags have no effect.
-DESCRIPTION
+Description
===========
This system call opens a named frontend device
@@ -70,7 +71,7 @@ powered up, and that other front-ends may have been powered down to make
that possible.
-RETURN VALUE
+Return Value
============
On success :ref:`open() <frontend_f_open>` returns the new file descriptor.
diff --git a/Documentation/linux_tv/media/dvb/net-add-if.rst b/Documentation/linux_tv/media/dvb/net-add-if.rst
index dc9735d871ee..2b990d0e0fe1 100644
--- a/Documentation/linux_tv/media/dvb/net-add-if.rst
+++ b/Documentation/linux_tv/media/dvb/net-add-if.rst
@@ -6,18 +6,19 @@
ioctl NET_ADD_IF
****************
-NAME
+Name
====
NET_ADD_IF - Creates a new network interface for a given Packet ID.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-DESCRIPTION
+Description
===========
The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
@@ -82,7 +83,7 @@ struct dvb_net_if description
``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/net-get-if.rst b/Documentation/linux_tv/media/dvb/net-get-if.rst
index 16dfe78eb77f..92b884143ccd 100644
--- a/Documentation/linux_tv/media/dvb/net-get-if.rst
+++ b/Documentation/linux_tv/media/dvb/net-get-if.rst
@@ -6,18 +6,19 @@
ioctl NET_GET_IF
****************
-NAME
+Name
====
NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF <net>`.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
pointer to struct :ref:`dvb_net_if <dvb-net-if>`
-DESCRIPTION
+Description
===========
The NET_GET_IF ioctl uses the interface number given by the struct
@@ -41,7 +42,7 @@ created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill
the ``errno`` with ``EINVAL`` error code.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/net-remove-if.rst b/Documentation/linux_tv/media/dvb/net-remove-if.rst
index c4177833ecf6..d374c1d63d06 100644
--- a/Documentation/linux_tv/media/dvb/net-remove-if.rst
+++ b/Documentation/linux_tv/media/dvb/net-remove-if.rst
@@ -6,18 +6,19 @@
ioctl NET_REMOVE_IF
*******************
-NAME
+Name
====
NET_REMOVE_IF - Removes a network interface.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, int ifnum )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,14 +31,14 @@ ARGUMENTS
number of the interface to be removed
-DESCRIPTION
+Description
===========
The NET_REMOVE_IF ioctl deletes an interface previously created via
:ref:`NET_ADD_IF <net>`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
index e6d2825f4c9b..dd227ad85546 100644
--- a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
+++ b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
@@ -6,18 +6,19 @@
VIDEO_CLEAR_BUFFER
==================
-NAME
+Name
----
VIDEO_CLEAR_BUFFER
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,14 +39,14 @@ ARGUMENTS
- Equals VIDEO_CLEAR_BUFFER for this command.
-DESCRIPTION
+Description
-----------
This ioctl call clears all video buffers in the driver and in the
decoder hardware.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-command.rst b/Documentation/linux_tv/media/dvb/video-command.rst
index 1743f40145ff..42a98a47e323 100644
--- a/Documentation/linux_tv/media/dvb/video-command.rst
+++ b/Documentation/linux_tv/media/dvb/video-command.rst
@@ -6,18 +6,19 @@
VIDEO_COMMAND
=============
-NAME
+Name
----
VIDEO_COMMAND
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Commands the decoder.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
@@ -57,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
more information.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-continue.rst b/Documentation/linux_tv/media/dvb/video-continue.rst
index 453a87dfb40d..2a6444a4f4dc 100644
--- a/Documentation/linux_tv/media/dvb/video-continue.rst
+++ b/Documentation/linux_tv/media/dvb/video-continue.rst
@@ -6,18 +6,19 @@
VIDEO_CONTINUE
==============
-NAME
+Name
----
VIDEO_CONTINUE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_CONTINUE for this command.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
@@ -48,7 +49,7 @@ This ioctl call restarts decoding and playing processes of the video
stream which was played before a call to VIDEO_FREEZE was made.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-fast-forward.rst b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
index 586a23bb5cfd..0b3a27a22d30 100644
--- a/Documentation/linux_tv/media/dvb/video-fast-forward.rst
+++ b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
@@ -6,18 +6,19 @@
VIDEO_FAST_FORWARD
==================
-NAME
+Name
----
VIDEO_FAST_FORWARD
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- The number of frames to skip.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to skip decoding of N number of
@@ -52,7 +53,7 @@ I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is
selected.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-fclose.rst b/Documentation/linux_tv/media/dvb/video-fclose.rst
index e98673768d2b..b4dd5ea676b9 100644
--- a/Documentation/linux_tv/media/dvb/video-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/video-fclose.rst
@@ -6,18 +6,19 @@
dvb video close()
=================
-NAME
+Name
----
dvb video close()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int close(int fd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -32,13 +33,13 @@ ARGUMENTS
- File descriptor returned by a previous call to open().
-DESCRIPTION
+Description
-----------
This system call closes a previously opened video device.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/video-fopen.rst b/Documentation/linux_tv/media/dvb/video-fopen.rst
index 3c30fef2aab6..31d4d62b2c7c 100644
--- a/Documentation/linux_tv/media/dvb/video-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/video-fopen.rst
@@ -6,18 +6,19 @@
dvb video open()
================
-NAME
+Name
----
dvb video open()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -58,7 +59,7 @@ ARGUMENTS
- (blocking mode is the default)
-DESCRIPTION
+Description
-----------
This system call opens a named video device (e.g.
@@ -78,7 +79,7 @@ ioctl call that can be used is VIDEO_GET_STATUS. All other call will
return an error code.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/video-freeze.rst b/Documentation/linux_tv/media/dvb/video-freeze.rst
index 8fbc7835382c..12e04df990b7 100644
--- a/Documentation/linux_tv/media/dvb/video-freeze.rst
+++ b/Documentation/linux_tv/media/dvb/video-freeze.rst
@@ -6,18 +6,19 @@
VIDEO_FREEZE
============
-NAME
+Name
----
VIDEO_FREEZE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_FREEZE for this command.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
@@ -52,7 +53,7 @@ VIDEO_SELECT_SOURCE, the DVB subsystem will not decode any more data
until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-fwrite.rst b/Documentation/linux_tv/media/dvb/video-fwrite.rst
index f56c89caef32..da03db4be8de 100644
--- a/Documentation/linux_tv/media/dvb/video-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/video-fwrite.rst
@@ -6,18 +6,19 @@
dvb video write()
=================
-NAME
+Name
----
dvb video write()
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: size_t write(int fd, const void *buf, size_t count)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Size of buf.
-DESCRIPTION
+Description
-----------
This system call can only be used if VIDEO_SOURCE_MEMORY is selected
@@ -54,7 +55,7 @@ is not specified the function will block until buffer space is
available. The amount of data to be transferred is implied by count.
-RETURN VALUE
+Return Value
------------
.. flat-table::
diff --git a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
index 5666ae7f20c0..5515dd40a1c1 100644
--- a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
@@ -6,18 +6,19 @@
VIDEO_GET_CAPABILITIES
======================
-NAME
+Name
----
VIDEO_GET_CAPABILITIES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to a location where to store the capability information.
-DESCRIPTION
+Description
-----------
This ioctl call asks the video device about its decoding capabilities.
@@ -52,7 +53,7 @@ On success it returns and integer which has bits set according to the
defines in section ??.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-get-event.rst b/Documentation/linux_tv/media/dvb/video-get-event.rst
index b08ca148ecdc..d43459915179 100644
--- a/Documentation/linux_tv/media/dvb/video-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-event.rst
@@ -6,18 +6,19 @@
VIDEO_GET_EVENT
===============
-NAME
+Name
----
VIDEO_GET_EVENT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Points to the location where the event, if any, is to be stored.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To get events from a V4L2 decoder
@@ -62,7 +63,7 @@ specified as the wake-up condition. Read-only permissions are sufficient
for this ioctl call.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
index 97ec05810154..a55f7a1d52ac 100644
--- a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
@@ -6,18 +6,19 @@
VIDEO_GET_FRAME_COUNT
=====================
-NAME
+Name
----
VIDEO_GET_FRAME_COUNT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -45,7 +46,7 @@ ARGUMENTS
started.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
@@ -56,7 +57,7 @@ This ioctl call asks the Video Device to return the number of displayed
frames since the decoder was started.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
index 62a85be537ab..a137b6589599 100644
--- a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
@@ -6,18 +6,19 @@
VIDEO_GET_FRAME_RATE
====================
-NAME
+Name
----
VIDEO_GET_FRAME_RATE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Returns the framerate in number of frames per 1000 seconds.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to return the current framerate.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-get-navi.rst b/Documentation/linux_tv/media/dvb/video-get-navi.rst
index 95dea513bc48..ccb2552722f0 100644
--- a/Documentation/linux_tv/media/dvb/video-get-navi.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-navi.rst
@@ -6,18 +6,19 @@
VIDEO_GET_NAVI
==============
-NAME
+Name
----
VIDEO_GET_NAVI
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- PCI or DSI pack (private stream 2) according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl returns navigational information from the DVD stream. This is
@@ -52,7 +53,7 @@ especially needed if an encoded stream has to be decoded by the
hardware.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-get-pts.rst b/Documentation/linux_tv/media/dvb/video-get-pts.rst
index f56e02a1f447..c1ad9576963d 100644
--- a/Documentation/linux_tv/media/dvb/video-get-pts.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-pts.rst
@@ -6,18 +6,19 @@
VIDEO_GET_PTS
=============
-NAME
+Name
----
VIDEO_GET_PTS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -49,7 +50,7 @@ ARGUMENTS
decoded frame or the last PTS extracted by the PES parser.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
@@ -60,7 +61,7 @@ This ioctl call asks the Video Device to return the current PTS
timestamp.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-get-size.rst b/Documentation/linux_tv/media/dvb/video-get-size.rst
index cbdf976223e5..70fb266e3ed8 100644
--- a/Documentation/linux_tv/media/dvb/video-get-size.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-size.rst
@@ -6,18 +6,19 @@
VIDEO_GET_SIZE
==============
-NAME
+Name
----
VIDEO_GET_SIZE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- Returns the size and aspect ratio.
-DESCRIPTION
+Description
-----------
This ioctl returns the size and aspect ratio.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-get-status.rst b/Documentation/linux_tv/media/dvb/video-get-status.rst
index 25344bf0ea7b..5fd5b37942ec 100644
--- a/Documentation/linux_tv/media/dvb/video-get-status.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-status.rst
@@ -6,18 +6,19 @@
VIDEO_GET_STATUS
================
-NAME
+Name
----
VIDEO_GET_STATUS
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- Returns the current status of the Video Device.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to return the current status of
the device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-play.rst b/Documentation/linux_tv/media/dvb/video-play.rst
index 18252d9d2ce6..103d0ad3341a 100644
--- a/Documentation/linux_tv/media/dvb/video-play.rst
+++ b/Documentation/linux_tv/media/dvb/video-play.rst
@@ -6,18 +6,19 @@
VIDEO_PLAY
==========
-NAME
+Name
----
VIDEO_PLAY
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -38,7 +39,7 @@ ARGUMENTS
- Equals VIDEO_PLAY for this command.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
@@ -48,7 +49,7 @@ This ioctl call asks the Video Device to start playing a video stream
from the selected source.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-select-source.rst b/Documentation/linux_tv/media/dvb/video-select-source.rst
index 2e76af3d468b..f03c544668f5 100644
--- a/Documentation/linux_tv/media/dvb/video-select-source.rst
+++ b/Documentation/linux_tv/media/dvb/video-select-source.rst
@@ -6,18 +6,19 @@
VIDEO_SELECT_SOURCE
===================
-NAME
+Name
----
VIDEO_SELECT_SOURCE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Indicates which source shall be used for the Video stream.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. This ioctl was also supported by the
@@ -56,7 +57,7 @@ the input data. The possible sources are demux or memory. If memory is
selected, the data is fed to the video device through the write command.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-attributes.rst b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
index 6de9378ce1c7..9de0d9c7c9ca 100644
--- a/Documentation/linux_tv/media/dvb/video-set-attributes.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
@@ -6,18 +6,19 @@
VIDEO_SET_ATTRIBUTES
====================
-NAME
+Name
----
VIDEO_SET_ATTRIBUTES
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- video attributes according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl is intended for DVD playback and allows you to set certain
@@ -53,7 +54,7 @@ information, but the call also tells the hardware to prepare for DVD
playback.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-blank.rst b/Documentation/linux_tv/media/dvb/video-set-blank.rst
index 62b46b8b2d02..d8b94c9b56b9 100644
--- a/Documentation/linux_tv/media/dvb/video-set-blank.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-blank.rst
@@ -6,18 +6,19 @@
VIDEO_SET_BLANK
===============
-NAME
+Name
----
VIDEO_SET_BLANK
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -49,13 +50,13 @@ ARGUMENTS
- FALSE: Show last decoded frame.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to blank out the picture.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-display-format.rst b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
index 7aec080638de..c1fb7c75b4a8 100644
--- a/Documentation/linux_tv/media/dvb/video-set-display-format.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
@@ -6,18 +6,19 @@
VIDEO_SET_DISPLAY_FORMAT
========================
-NAME
+Name
----
VIDEO_SET_DISPLAY_FORMAT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- Selects the video format to be used.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to select the video format to be
applied by the MPEG chip on the video.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-format.rst b/Documentation/linux_tv/media/dvb/video-set-format.rst
index af126d2de8c3..257a3c2a4627 100644
--- a/Documentation/linux_tv/media/dvb/video-set-format.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-format.rst
@@ -6,18 +6,19 @@
VIDEO_SET_FORMAT
================
-NAME
+Name
----
VIDEO_SET_FORMAT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- video format of TV as defined in section ??.
-DESCRIPTION
+Description
-----------
This ioctl sets the screen format (aspect ratio) of the connected output
@@ -52,7 +53,7 @@ device (TV) so that the output of the decoder can be adjusted
accordingly.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-highlight.rst b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
index d8628d282740..6ff11af71355 100644
--- a/Documentation/linux_tv/media/dvb/video-set-highlight.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
@@ -6,18 +6,19 @@
VIDEO_SET_HIGHLIGHT
===================
-NAME
+Name
----
VIDEO_SET_HIGHLIGHT
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- SPU Highlight information according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl sets the SPU highlight information for the menu access of a
DVD.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-id.rst b/Documentation/linux_tv/media/dvb/video-set-id.rst
index 31ca41f8b6af..61993ab354ca 100644
--- a/Documentation/linux_tv/media/dvb/video-set-id.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-id.rst
@@ -6,18 +6,19 @@
VIDEO_SET_ID
============
-NAME
+Name
----
VIDEO_SET_ID
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,14 +45,14 @@ ARGUMENTS
- video sub-stream id
-DESCRIPTION
+Description
-----------
This ioctl selects which sub-stream is to be decoded if a program or
system stream is sent to the video device.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
index b3b727fec64b..ae9e0da5fd0b 100644
--- a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
@@ -6,18 +6,19 @@
VIDEO_SET_SPU_PALETTE
=====================
-NAME
+Name
----
VIDEO_SET_SPU_PALETTE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,13 +45,13 @@ ARGUMENTS
- SPU palette according to section ??.
-DESCRIPTION
+Description
-----------
This ioctl sets the SPU color palette.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu.rst b/Documentation/linux_tv/media/dvb/video-set-spu.rst
index d00d0b5272d7..ce2860574f20 100644
--- a/Documentation/linux_tv/media/dvb/video-set-spu.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-spu.rst
@@ -6,18 +6,19 @@
VIDEO_SET_SPU
=============
-NAME
+Name
----
VIDEO_SET_SPU
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -45,14 +46,14 @@ ARGUMENTS
??.
-DESCRIPTION
+Description
-----------
This ioctl activates or deactivates SPU decoding in a DVD input stream.
It can only be used, if the driver is able to handle a DVD stream.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
index 6875ff8db77e..a2055369f0cd 100644
--- a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
@@ -6,18 +6,19 @@
VIDEO_SET_STREAMTYPE
====================
-NAME
+Name
----
VIDEO_SET_STREAMTYPE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- stream type
-DESCRIPTION
+Description
-----------
This ioctl tells the driver which kind of stream to expect being written
@@ -52,7 +53,7 @@ to it. If this call is not used the default of video PES is used. Some
drivers might not support this call and always expect PES.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-set-system.rst b/Documentation/linux_tv/media/dvb/video-set-system.rst
index 7fcd1a1fb78b..f84906a7d1f4 100644
--- a/Documentation/linux_tv/media/dvb/video-set-system.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-system.rst
@@ -6,18 +6,19 @@
VIDEO_SET_SYSTEM
================
-NAME
+Name
----
VIDEO_SET_SYSTEM
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- video system of TV output.
-DESCRIPTION
+Description
-----------
This ioctl sets the television output format. The format (see section
@@ -53,7 +54,7 @@ hardware is not able to display the requested format the call will
return an error.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-slowmotion.rst b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
index 6472abb1e42d..c8cc85af590b 100644
--- a/Documentation/linux_tv/media/dvb/video-slowmotion.rst
+++ b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
@@ -6,18 +6,19 @@
VIDEO_SLOWMOTION
================
-NAME
+Name
----
VIDEO_SLOWMOTION
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- The number of times to repeat each frame.
-DESCRIPTION
+Description
-----------
This ioctl call asks the video device to repeat decoding frames N number
@@ -52,7 +53,7 @@ of times. This call can only be used if VIDEO_SOURCE_MEMORY is
selected.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-stillpicture.rst b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
index 93c9c30bcdd3..053cdbba4ed4 100644
--- a/Documentation/linux_tv/media/dvb/video-stillpicture.rst
+++ b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
@@ -6,18 +6,19 @@
VIDEO_STILLPICTURE
==================
-NAME
+Name
----
VIDEO_STILLPICTURE
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Pointer to a location where an I-frame and size is stored.
-DESCRIPTION
+Description
-----------
This ioctl call asks the Video Device to display a still picture
@@ -52,7 +53,7 @@ This ioctl call asks the Video Device to display a still picture
NULL, then the current displayed still picture is blanked.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-stop.rst b/Documentation/linux_tv/media/dvb/video-stop.rst
index 2dbf464d85bb..4e7fbab4b8bc 100644
--- a/Documentation/linux_tv/media/dvb/video-stop.rst
+++ b/Documentation/linux_tv/media/dvb/video-stop.rst
@@ -6,18 +6,19 @@
VIDEO_STOP
==========
-NAME
+Name
----
VIDEO_STOP
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -54,7 +55,7 @@ ARGUMENTS
- FALSE: Show last decoded frame.
-DESCRIPTION
+Description
-----------
This ioctl is for DVB devices only. To control a V4L2 decoder use the
@@ -65,7 +66,7 @@ stream. Depending on the input parameter, the screen can be blanked out
or displaying the last decoded frame.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/dvb/video-try-command.rst b/Documentation/linux_tv/media/dvb/video-try-command.rst
index b30cfcd05682..be21fb01bd0f 100644
--- a/Documentation/linux_tv/media/dvb/video-try-command.rst
+++ b/Documentation/linux_tv/media/dvb/video-try-command.rst
@@ -6,18 +6,19 @@
VIDEO_TRY_COMMAND
=================
-NAME
+Name
----
VIDEO_TRY_COMMAND
-SYNOPSIS
+
+Synopsis
--------
.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
-ARGUMENTS
+Arguments
---------
.. flat-table::
@@ -44,7 +45,7 @@ ARGUMENTS
- Try a decoder command.
-DESCRIPTION
+Description
-----------
This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders
@@ -57,7 +58,7 @@ subset of the ``v4l2_decoder_cmd`` struct, so refer to the
for more information.
-RETURN VALUE
+Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-func-close.rst b/Documentation/linux_tv/media/mediactl/media-func-close.rst
index 7ec0baa83482..3f3d9bb1f32a 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-close.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-close.rst
@@ -6,12 +6,13 @@
media close()
*************
-NAME
+Name
====
media-close - Close a media device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,21 +23,21 @@ SYNOPSIS
.. cpp:function:: int close( int fd )
-ARGUMENTS
+Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-DESCRIPTION
+Description
===========
Closes the media device. Resources associated with the file descriptor
are freed. The device configuration remain unchanged.
-RETURN VALUE
+Return Value
============
:ref:`close() <func-close>` returns 0 on success. On error, -1 is returned, and
diff --git a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
index 0d8f706b7e74..1b28e2d20de4 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
@@ -6,12 +6,13 @@
media ioctl()
*************
-NAME
+Name
====
media-ioctl - Control a media device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, void *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -36,7 +37,7 @@ ARGUMENTS
Pointer to a request-specific structure.
-DESCRIPTION
+Description
===========
The :ref:`ioctl() <func-ioctl>` function manipulates media device parameters.
@@ -52,7 +53,7 @@ requests, their respective function and parameters are specified in
:ref:`media-user-func`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-func-open.rst b/Documentation/linux_tv/media/mediactl/media-func-open.rst
index 353114fcb7ca..43b9ddc5c38f 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-open.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-open.rst
@@ -6,12 +6,13 @@
media open()
************
-NAME
+Name
====
media-open - Open a media device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int open( const char *device_name, int flags )
-ARGUMENTS
+Arguments
=========
``device_name``
@@ -33,7 +34,7 @@ ARGUMENTS
Other flags have no effect.
-DESCRIPTION
+Description
===========
To open a media device applications call :ref:`open() <func-open>` with the
@@ -45,7 +46,7 @@ configuration will result in an error, and ``errno`` will be set to
EBADF.
-RETURN VALUE
+Return Value
============
:ref:`open() <func-open>` returns the new file descriptor on success. On error,
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst b/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst
index 52fe981a4036..cee8312bde7d 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst
@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_DEVICE_INFO
***************************
-NAME
+Name
====
MEDIA_IOC_DEVICE_INFO - Query device information
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_device_info *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
All media devices must support the ``MEDIA_IOC_DEVICE_INFO`` ioctl. To
@@ -133,7 +134,7 @@ used instead. The ``bus_info`` field is guaranteed to be unique, but can
vary across reboots or device unplug/replug.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
index 5d11572d4848..f11c45ad7278 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_ENUM_ENTITIES
*****************************
-NAME
+Name
====
MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of an entity, applications set the id field of a
@@ -183,7 +184,7 @@ id's until they get an error.
-
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst b/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst
index 88bf10b35ff0..cc3cc3d2400b 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst
@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_ENUM_LINKS
**************************
-NAME
+Name
====
MEDIA_IOC_ENUM_LINKS - Enumerate all pads and links for a given entity
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_links_enum *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To enumerate pads and/or links for a given entity, applications set the
@@ -159,7 +160,7 @@ returned during the enumeration process.
- Link flags, see :ref:`media-link-flag` for more details.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
index 34d46010c971..badcdf6133e2 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_G_TOPOLOGY
**************************
-NAME
+Name
====
MEDIA_IOC_G_TOPOLOGY - Enumerate the graph topology and graph element properties
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_v2_topology *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The typical usage of this ioctl is to call it twice. On the first call,
@@ -410,7 +411,7 @@ desired arrays with the media graph elements.
this array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst b/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst
index f02edbcd3048..57ae5bcc646a 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst
@@ -6,18 +6,19 @@
ioctl MEDIA_IOC_SETUP_LINK
**************************
-NAME
+Name
====
MEDIA_IOC_SETUP_LINK - Modify the properties of a link
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct media_link_desc *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To change link properties applications fill a struct
@@ -54,7 +55,7 @@ If the specified link can't be found the driver returns with an ``EINVAL``
error code.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/func-close.rst b/Documentation/linux_tv/media/v4l/func-close.rst
index 81401cd26d12..926a2ccc32e5 100644
--- a/Documentation/linux_tv/media/v4l/func-close.rst
+++ b/Documentation/linux_tv/media/v4l/func-close.rst
@@ -6,12 +6,13 @@
V4L2 close()
************
-NAME
+Name
====
v4l2-close - Close a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,14 +23,14 @@ SYNOPSIS
.. cpp:function:: int close( int fd )
-ARGUMENTS
+Arguments
=========
``fd``
File descriptor returned by :ref:`open() <func-open>`.
-DESCRIPTION
+Description
===========
Closes the device. Any I/O in progress is terminated and resources
@@ -38,7 +39,7 @@ parameters, current input or output, control values or other properties
remain unchanged.
-RETURN VALUE
+Return Value
============
The function returns 0 on success, -1 on failure and the ``errno`` is
diff --git a/Documentation/linux_tv/media/v4l/func-ioctl.rst b/Documentation/linux_tv/media/v4l/func-ioctl.rst
index 91917e976dd0..5632f48fce1b 100644
--- a/Documentation/linux_tv/media/v4l/func-ioctl.rst
+++ b/Documentation/linux_tv/media/v4l/func-ioctl.rst
@@ -6,12 +6,13 @@
V4L2 ioctl()
************
-NAME
+Name
====
v4l2-ioctl - Program a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, void *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -36,7 +37,7 @@ ARGUMENTS
Pointer to a function parameter, usually a structure.
-DESCRIPTION
+Description
===========
The :ref:`ioctl() <func-ioctl>` function is used to program V4L2 devices. The
@@ -50,7 +51,7 @@ All V4L2 ioctl requests, their respective function and parameters are
specified in :ref:`user-func`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/func-mmap.rst b/Documentation/linux_tv/media/v4l/func-mmap.rst
index 01a45e217265..3502c2afd894 100644
--- a/Documentation/linux_tv/media/v4l/func-mmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-mmap.rst
@@ -6,12 +6,13 @@
V4L2 mmap()
***********
-NAME
+Name
====
v4l2-mmap - Map device memory into application address space
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -23,7 +24,7 @@ SYNOPSIS
.. cpp:function:: void *mmap( void *start, size_t length, int prot, int flags, int fd, off_t offset )
-ARGUMENTS
+Arguments
=========
``start``
@@ -90,7 +91,7 @@ ARGUMENTS
``mem_offset`` field for the multi-planar API.
-DESCRIPTION
+Description
===========
The :ref:`mmap() <func-mmap>` function asks to map ``length`` bytes starting at
@@ -106,7 +107,7 @@ before they can be queried.
To unmap buffers the :ref:`munmap() <func-munmap>` function is used.
-RETURN VALUE
+Return Value
============
On success :ref:`mmap() <func-mmap>` returns a pointer to the mapped buffer. On
diff --git a/Documentation/linux_tv/media/v4l/func-munmap.rst b/Documentation/linux_tv/media/v4l/func-munmap.rst
index a6e7a6def558..c29c03f21279 100644
--- a/Documentation/linux_tv/media/v4l/func-munmap.rst
+++ b/Documentation/linux_tv/media/v4l/func-munmap.rst
@@ -6,12 +6,13 @@
V4L2 munmap()
*************
-NAME
+Name
====
v4l2-munmap - Unmap device memory
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -23,7 +24,7 @@ SYNOPSIS
.. cpp:function:: int munmap( void *start, size_t length )
-ARGUMENTS
+Arguments
=========
``start``
@@ -39,14 +40,14 @@ ARGUMENTS
multi-planar API.
-DESCRIPTION
+Description
===========
Unmaps a previously with the :ref:`mmap() <func-mmap>` function mapped
buffer and frees it, if possible.
-RETURN VALUE
+Return Value
============
On success :ref:`munmap() <func-munmap>` returns 0, on failure -1 and the
diff --git a/Documentation/linux_tv/media/v4l/func-open.rst b/Documentation/linux_tv/media/v4l/func-open.rst
index 152174e6f646..06bcadc269a4 100644
--- a/Documentation/linux_tv/media/v4l/func-open.rst
+++ b/Documentation/linux_tv/media/v4l/func-open.rst
@@ -6,12 +6,13 @@
V4L2 open()
***********
-NAME
+Name
====
v4l2-open - Open a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: int open( const char *device_name, int flags )
-ARGUMENTS
+Arguments
=========
``device_name``
@@ -43,7 +44,7 @@ ARGUMENTS
Other flags have no effect.
-DESCRIPTION
+Description
===========
To open a V4L2 device applications call :ref:`open() <func-open>` with the
@@ -54,7 +55,7 @@ driver they will be reset to default values, drivers are never in an
undefined state.
-RETURN VALUE
+Return Value
============
On success :ref:`open() <func-open>` returns the new file descriptor. On error
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index 8632e05ff5b2..e6ceb712b783 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -6,12 +6,13 @@
V4L2 poll()
***********
-NAME
+Name
====
v4l2-poll - Wait for some event on a file descriptor
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,12 +23,12 @@ SYNOPSIS
.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
-ARGUMENTS
+Arguments
=========
-DESCRIPTION
+Description
===========
With the :ref:`poll() <func-poll>` function applications can suspend execution
@@ -90,7 +91,7 @@ function.
For more details see the :ref:`poll() <func-poll>` manual page.
-RETURN VALUE
+Return Value
============
On success, :ref:`poll() <func-poll>` returns the number structures which have
diff --git a/Documentation/linux_tv/media/v4l/func-read.rst b/Documentation/linux_tv/media/v4l/func-read.rst
index c4f0e8ab9e14..9a2aa5210233 100644
--- a/Documentation/linux_tv/media/v4l/func-read.rst
+++ b/Documentation/linux_tv/media/v4l/func-read.rst
@@ -6,12 +6,13 @@
V4L2 read()
***********
-NAME
+Name
====
v4l2-read - Read from a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: ssize_t read( int fd, void *buf, size_t count )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -32,7 +33,7 @@ ARGUMENTS
``count``
-DESCRIPTION
+Description
===========
:ref:`read() <func-read>` attempts to read up to ``count`` bytes from file
@@ -92,7 +93,7 @@ however. The discarding policy is not reported and cannot be changed.
For minimum requirements see :ref:`devices`.
-RETURN VALUE
+Return Value
============
On success, the number of bytes read is returned. It is not an error if
diff --git a/Documentation/linux_tv/media/v4l/func-select.rst b/Documentation/linux_tv/media/v4l/func-select.rst
index 34ade67d0f68..954dd00b8301 100644
--- a/Documentation/linux_tv/media/v4l/func-select.rst
+++ b/Documentation/linux_tv/media/v4l/func-select.rst
@@ -6,12 +6,13 @@
V4L2 select()
*************
-NAME
+Name
====
v4l2-select - Synchronous I/O multiplexing
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -24,12 +25,12 @@ SYNOPSIS
.. cpp:function:: int select( int nfds, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout )
-ARGUMENTS
+Arguments
=========
-DESCRIPTION
+Description
===========
With the :ref:`select() <func-select>` function applications can suspend
@@ -71,7 +72,7 @@ function.
For more details see the :ref:`select() <func-select>` manual page.
-RETURN VALUE
+Return Value
============
On success, :ref:`select() <func-select>` returns the number of descriptors
diff --git a/Documentation/linux_tv/media/v4l/func-write.rst b/Documentation/linux_tv/media/v4l/func-write.rst
index 6609f191af76..a3bc9b26fe56 100644
--- a/Documentation/linux_tv/media/v4l/func-write.rst
+++ b/Documentation/linux_tv/media/v4l/func-write.rst
@@ -6,12 +6,13 @@
V4L2 write()
************
-NAME
+Name
====
v4l2-write - Write to a V4L2 device
-SYNOPSIS
+
+Synopsis
========
.. code-block:: c
@@ -22,7 +23,7 @@ SYNOPSIS
.. cpp:function:: ssize_t write( int fd, void *buf, size_t count )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -32,7 +33,7 @@ ARGUMENTS
``count``
-DESCRIPTION
+Description
===========
:ref:`write() <func-write>` writes up to ``count`` bytes to the device
@@ -47,7 +48,7 @@ Sliced Teletext or Closed Caption data is not repeated, the driver
inserts a blank line instead.
-RETURN VALUE
+Return Value
============
On success, the number of bytes written are returned. Zero indicates
diff --git a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
index fe179197536d..abdc0b4d83d5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_CREATE_BUFS
************************
-NAME
+Name
====
VIDIOC_CREATE_BUFS - Create buffers for Memory Mapped or User Pointer or DMA Buffer I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_create_buffers *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
This ioctl is used to create buffers for :ref:`memory mapped <mmap>`
@@ -130,7 +131,7 @@ than the number requested.
must set the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
index 17ae3aa738b0..8dcbe6d26219 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-cropcap.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_CROPCAP
********************
-NAME
+Name
====
VIDIOC_CROPCAP - Information about the video cropping and scaling abilities
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_cropcap *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Applications use this function to query the cropping limits, the pixel
@@ -154,7 +155,7 @@ overlay devices.
- Height of the rectangle, in pixels.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
index 913c6d47d821..efa911c0fb19 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_DBG_G_CHIP_INFO
****************************
-NAME
+Name
====
VIDIOC_DBG_G_CHIP_INFO - Identify the chips on a TV card
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_chip_info *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
**Note**
@@ -192,7 +193,7 @@ instructions.
- Match the nth sub-device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
index 185a011a117c..345aa321f380 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_DBG_G_REGISTER, VIDIOC_DBG_S_REGISTER
**************************************************
-NAME
+Name
====
VIDIOC_DBG_G_REGISTER - VIDIOC_DBG_S_REGISTER - Read or write hardware registers
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dbg_register *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_dbg_register *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
**Note**
@@ -196,7 +197,7 @@ instructions.
- Match the nth sub-device.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
index bb6d9b8cf122..2a36e91b57b9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_DECODER_CMD, VIDIOC_TRY_DECODER_CMD
************************************************
-NAME
+Name
====
VIDIOC_DECODER_CMD - VIDIOC_TRY_DECODER_CMD - Execute an decoder command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_decoder_cmd *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls control an audio/video (usually MPEG-) decoder.
@@ -255,7 +256,7 @@ introduced in Linux 3.3.
flags are defined for this command.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
index 850cb5ed0015..73c0d5be62ee 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dqevent.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_DQEVENT
********************
-NAME
+Name
====
VIDIOC_DQEVENT - Dequeue event
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Dequeue an event from a video device. No input is required for this
@@ -564,7 +565,7 @@ call.
decoder.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
index 61fef531363c..b56cdef7673e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_DV_TIMINGS_CAP, VIDIOC_SUBDEV_DV_TIMINGS_CAP
*********************************************************
-NAME
+Name
====
VIDIOC_DV_TIMINGS_CAP - VIDIOC_SUBDEV_DV_TIMINGS_CAP - The capabilities of the Digital Video receiver/transmitter
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings_cap *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the capabilities of the DV receiver/transmitter applications
@@ -241,7 +242,7 @@ that doesn't support them will return an ``EINVAL`` error code.
the standards set in the ``standards`` field.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
index 1991014fd6b5..69bd9b4e0e56 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENCODER_CMD, VIDIOC_TRY_ENCODER_CMD
************************************************
-NAME
+Name
====
VIDIOC_ENCODER_CMD - VIDIOC_TRY_ENCODER_CMD - Execute an encoder command
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_encoder_cmd *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls control an audio/video (usually MPEG-) encoder.
@@ -179,7 +180,7 @@ introduced in Linux 2.6.21.
rather than immediately.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
index 41fa4313c1c2..f0dd0c4ca7d0 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_DV_TIMINGS, VIDIOC_SUBDEV_ENUM_DV_TIMINGS
***********************************************************
-NAME
+Name
====
VIDIOC_ENUM_DV_TIMINGS - VIDIOC_SUBDEV_ENUM_DV_TIMINGS - Enumerate supported Digital Video timings
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enum_dv_timings *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
While some DV receivers or transmitters support a wide range of timings,
@@ -103,7 +104,7 @@ return an ``EINVAL`` error code.
- The timings.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
index 3b935b07837a..257c624e27be 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FMT
*********************
-NAME
+Name
====
VIDIOC_ENUM_FMT - Enumerate image formats
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_fmtdesc *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To enumerate image formats applications initialize the ``type`` and
@@ -151,7 +152,7 @@ formats may be different.
format instead for better performance.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
index 3336a166b878..5d5de535a0fe 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FRAMEINTERVALS
********************************
-NAME
+Name
====
VIDIOC_ENUM_FRAMEINTERVALS - Enumerate frame intervals
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmivalenum *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -32,7 +33,7 @@ ARGUMENTS
interval.
-DESCRIPTION
+Description
===========
This ioctl allows applications to enumerate all frame intervals that the
@@ -265,7 +266,7 @@ Enums
- Step-wise defined frame interval.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
index d01fffaeda04..d3b2e97df6c9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FRAMESIZES
****************************
-NAME
+Name
====
VIDIOC_ENUM_FRAMESIZES - Enumerate frame sizes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frmsizeenum *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -32,7 +33,7 @@ ARGUMENTS
and height.
-DESCRIPTION
+Description
===========
This ioctl allows applications to enumerate all frame sizes (i. e. width
@@ -282,7 +283,7 @@ Enums
- Step-wise defined frame size.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
index 7fdde4be282c..ea754f4f5532 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUM_FREQ_BANDS
****************************
-NAME
+Name
====
VIDIOC_ENUM_FREQ_BANDS - Enumerate supported frequency bands
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency_band *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Enumerates the frequency bands that a tuner or modulator supports. To do
@@ -177,7 +178,7 @@ of the corresponding tuner/modulator is set.
- Amplitude Modulation, commonly used for analog radio.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
index f833e581f7c3..bfdc3533240d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMAUDIO
**********************
-NAME
+Name
====
VIDIOC_ENUMAUDIO - Enumerate audio inputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of an audio input applications initialize the
@@ -44,7 +45,7 @@ See :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` for a description of struct
:ref:`v4l2_audio <v4l2-audio>`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index f2caf6c71f44..4c1756319c09 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMAUDOUT
***********************
-NAME
+Name
====
VIDIOC_ENUMAUDOUT - Enumerate audio outputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of an audio output applications initialize the
@@ -47,7 +48,7 @@ See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDIOout>` for a description of struct
:ref:`v4l2_audioout <v4l2-audioout>`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
index 01a1cadc71d2..c1fc2e1f1d98 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enuminput.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMINPUT
**********************
-NAME
+Name
====
VIDIOC_ENUMINPUT - Enumerate video inputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_input *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a video input applications initialize the
@@ -354,7 +355,7 @@ at index zero, incrementing by one until the driver returns ``EINVAL``.
:ref:`v4l2-selections-common`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
index 99c70e54c4d6..82fc9d3b237f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMOUTPUT
***********************
-NAME
+Name
====
VIDIOC_ENUMOUTPUT - Enumerate video outputs
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_output *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a video outputs applications initialize the
@@ -209,7 +210,7 @@ EINVAL.
:ref:`v4l2-selections-common`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
index e74514ea4437..ce911c81bd3d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumstd.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_ENUMSTD
********************
-NAME
+Name
====
VIDIOC_ENUMSTD - Enumerate supported video standards
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_standard *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a video standard, especially a custom (driver
@@ -385,7 +386,7 @@ support digital TV. See also the Linux DVB API at
- + 6.5 [8]_
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
index 2c08a349ab45..ded708e647fa 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-expbuf.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_EXPBUF
*******************
-NAME
+Name
====
VIDIOC_EXPBUF - Export a buffer as a DMABUF file descriptor.
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_exportbuffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
This ioctl is an extension to the :ref:`memory mapping <mmap>` I/O
@@ -184,7 +185,7 @@ Examples
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
index 02db00a31722..cccbcdb8c463 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audio.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_AUDIO, VIDIOC_S_AUDIO
************************************
-NAME
+Name
====
VIDIOC_G_AUDIO - VIDIOC_S_AUDIO - Query or select the current audio input and its attributes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audio *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audio *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the current audio input applications zero out the ``reserved``
@@ -149,7 +150,7 @@ return the actual new audio mode.
- AVL mode is on.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index 9265be57d0f9..e36b5a116332 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
**************************************
-NAME
+Name
====
VIDIOC_G_AUDOUT - VIDIOC_S_AUDOUT - Query or select the current audio output
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_audioout *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_audioout *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the current audio output applications zero out the ``reserved``
@@ -108,7 +109,7 @@ sound card are not audio outputs in this sense.
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
index 206fdd5f825f..6cf76497937c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-crop.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_CROP, VIDIOC_S_CROP
**********************************
-NAME
+Name
====
VIDIOC_G_CROP - VIDIOC_S_CROP - Get or set the current cropping rectangle
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_crop *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_crop *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the cropping rectangle size and position applications set the
@@ -104,7 +105,7 @@ When cropping is not supported then no parameters are changed and
:ref:`v4l2_cropcap <v4l2-cropcap>` ``bounds`` is used.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
index 50fddb140288..ee929f692ebe 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_CTRL, VIDIOC_S_CTRL
**********************************
-NAME
+Name
====
VIDIOC_G_CTRL - VIDIOC_S_CTRL - Get or set the value of a control
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_control *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To get the current value of a control applications initialize the ``id``
@@ -78,7 +79,7 @@ These ioctls work only with user controls. For other control classes the
- New value or current value.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index f6e7fd261ebc..0dd93d1ee284 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_DV_TIMINGS, VIDIOC_S_DV_TIMINGS
**********************************************
-NAME
+Name
====
VIDIOC_G_DV_TIMINGS - VIDIOC_S_DV_TIMINGS - VIDIOC_SUBDEV_G_DV_TIMINGS - VIDIOC_SUBDEV_S_DV_TIMINGS - Get or set DV timings for input or output
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To set DV timings for the input or output, applications use the
@@ -49,7 +50,7 @@ the current input or output does not support DV timings (e.g. if
``V4L2_IN_CAP_DV_TIMINGS`` flag), then ``ENODATA`` error code is returned.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
index 1414026f5740..907b2c1764a3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-edid.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_EDID, VIDIOC_S_EDID, VIDIOC_SUBDEV_G_EDID, VIDIOC_SUBDEV_S_EDID
******************************************************************************
-NAME
+Name
====
VIDIOC_G_EDID - VIDIOC_S_EDID - VIDIOC_SUBDEV_G_EDID - VIDIOC_SUBDEV_S_EDID - Get or set the EDID of a video receiver/transmitter
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_edid *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls can be used to get or set an EDID associated with an input
@@ -143,7 +144,7 @@ EDID is no longer available.
``blocks`` * 128.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
index 16f0e8135952..f0f41ac56b80 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_ENC_INDEX
************************
-NAME
+Name
====
VIDIOC_G_ENC_INDEX - Get meta data about a compressed video stream
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_enc_idx *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The :ref:`VIDIOC_G_ENC_INDEX <VIDIOC_G_ENC_INDEX>` ioctl provides meta data about a compressed
@@ -201,7 +202,7 @@ video elementary streams.
type.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
index 2f69b1cf804b..96b6eaca755c 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_EXT_CTRLS, VIDIOC_S_EXT_CTRLS, VIDIOC_TRY_EXT_CTRLS
******************************************************************
-NAME
+Name
====
VIDIOC_G_EXT_CTRLS - VIDIOC_S_EXT_CTRLS - VIDIOC_TRY_EXT_CTRLS - Get or set the value of several controls, try control values
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_ext_controls *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls allow the caller to get or set multiple controls
@@ -451,7 +452,7 @@ still cause this situation.
described in :ref:`rf-tuner-controls`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
index 4d0799414420..ef4592c338ef 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_FBUF, VIDIOC_S_FBUF
**********************************
-NAME
+Name
====
VIDIOC_G_FBUF - VIDIOC_S_FBUF - Get or set frame buffer overlay parameters
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_framebuffer *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_framebuffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Applications can use the :ref:`VIDIOC_G_FBUF <VIDIOC_G_FBUF>` and :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>` ioctl
@@ -477,7 +478,7 @@ destructive video overlay.
:ref:`v4l2_window <v4l2-window>` is being used.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
index aede100b668b..ee6f11978fd6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_FMT, VIDIOC_S_FMT, VIDIOC_TRY_FMT
************************************************
-NAME
+Name
====
VIDIOC_G_FMT - VIDIOC_S_FMT - VIDIOC_TRY_FMT - Get or set the data format, try a format
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_format *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls are used to negotiate the format of data (typically image
@@ -175,7 +176,7 @@ The format as returned by :ref:`VIDIOC_TRY_FMT <VIDIOC_G_FMT>` must be identical
- Place holder for future extensions.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
index 2b921cda2e4d..a1fd2a870de4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_FREQUENCY, VIDIOC_S_FREQUENCY
********************************************
-NAME
+Name
====
VIDIOC_G_FREQUENCY - VIDIOC_S_FREQUENCY - Get or set tuner or modulator radio frequency
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_frequency *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_frequency *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To get the current tuner or modulator radio frequency applications set
@@ -107,7 +108,7 @@ write-only ioctl, it does not return the actual new frequency.
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
index e069ba3952ea..29e22f6f8028 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-input.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_INPUT, VIDIOC_S_INPUT
************************************
-NAME
+Name
====
VIDIOC_G_INPUT - VIDIOC_S_INPUT - Query or select the current video input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the current video input applications call the
@@ -50,7 +51,7 @@ Information about video inputs is available using the
:ref:`VIDIOC_ENUMINPUT` ioctl.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
index c8d3a3b53a51..f5bf8b7915ed 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_JPEGCOMP, VIDIOC_S_JPEGCOMP
******************************************
-NAME
+Name
====
VIDIOC_G_JPEGCOMP - VIDIOC_S_JPEGCOMP
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_jpegcompression *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const v4l2_jpegcompression *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls are **deprecated**. New drivers and applications should use
@@ -175,7 +176,7 @@ encoding. You usually do want to add them.
- App segment, driver will always use APP0
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
index 21b9fea34b8c..05d83610bdc5 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_MODULATOR, VIDIOC_S_MODULATOR
********************************************
-NAME
+Name
====
VIDIOC_G_MODULATOR - VIDIOC_S_MODULATOR - Get or set modulator attributes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_modulator *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_modulator *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a modulator applications initialize the
@@ -242,7 +243,7 @@ To change the radio frequency the
- Enable the RDS encoder for a radio FM transmitter.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
index c9fb075ec5d1..ae0ad577ba97 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-output.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_OUTPUT, VIDIOC_S_OUTPUT
**************************************
-NAME
+Name
====
VIDIOC_G_OUTPUT - VIDIOC_S_OUTPUT - Query or select the current video output
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the current video output applications call the
@@ -51,7 +52,7 @@ Information about video outputs is available using the
:ref:`VIDIOC_ENUMOUTPUT` ioctl.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
index 964e3b8ce275..7116e0decddc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-parm.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_PARM, VIDIOC_S_PARM
**********************************
-NAME
+Name
====
VIDIOC_G_PARM - VIDIOC_S_PARM - Get or set streaming parameters
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_streamparm *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The current video standard determines a nominal number of frames per
@@ -340,7 +341,7 @@ union holding separate parameters for input and output devices.
- Capture might only work through the :ref:`read() <func-read>` call.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
index 8255f2469cd9..4419195661f1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_PRIORITY, VIDIOC_S_PRIORITY
******************************************
-NAME
+Name
====
VIDIOC_G_PRIORITY - VIDIOC_S_PRIORITY - Query or request the access priority associated with a file descriptor
-SYNOPSIS
+
+Synopsis
========
.. c:function:: int ioctl( int fd, int request, enum v4l2_priority *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. c:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -32,7 +33,7 @@ ARGUMENTS
Pointer to an enum v4l2_priority type.
-DESCRIPTION
+Description
===========
To query the current access priority applications call the
@@ -102,7 +103,7 @@ with a pointer to this variable.
applications which must not be interrupted, like video recording.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
index c4164eaafca8..953931fabd00 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-selection.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_SELECTION, VIDIOC_S_SELECTION
********************************************
-NAME
+Name
====
VIDIOC_G_SELECTION - VIDIOC_S_SELECTION - Get or set one of the selection rectangles
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_selection *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The ioctls are used to query and configure selection rectangles.
@@ -187,7 +188,7 @@ Selection targets and flags are documented in
this array.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
index 466760241fdb..76dd4ba3254f 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_G_SLICED_VBI_CAP
*****************************
-NAME
+Name
====
VIDIOC_G_SLICED_VBI_CAP - Query sliced VBI capabilities
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_sliced_vbi_cap *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To find out which data services are supported by a sliced VBI capture or
@@ -264,7 +265,7 @@ to write-read, in Linux 2.6.19.
- :cspan:`2` Set of services applicable to 625 line systems.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
index 4fbc9e9bfeb8..5c2b861f8d26 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-std.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_STD, VIDIOC_S_STD
********************************
-NAME
+Name
====
VIDIOC_G_STD - VIDIOC_S_STD - Query or select the video standard of the current input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const v4l2_std_id *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query and select the current video standard applications use the
@@ -53,7 +54,7 @@ does not set the ``V4L2_IN_CAP_STD`` flag), then ``ENODATA`` error code is
returned.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
index fe904db57597..a8d7ebd73e8a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_G_TUNER, VIDIOC_S_TUNER
************************************
-NAME
+Name
====
VIDIOC_G_TUNER - VIDIOC_S_TUNER - Get or set tuner attributes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_tuner *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_tuner *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a tuner applications initialize the ``index``
@@ -692,7 +693,7 @@ To change the radio frequency the
- Lang1/Lang2 (preferred) or Lang1/Lang1
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
index d96d5e4f242a..66fc352c0ffa 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-log-status.rst
@@ -6,23 +6,24 @@
ioctl VIDIOC_LOG_STATUS
***********************
-NAME
+Name
====
VIDIOC_LOG_STATUS - Log driver status information
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request )
-ARGUMENTS
+Arguments
=========
-DESCRIPTION
+Description
===========
As the video/audio devices become more complicated it becomes harder to
@@ -37,7 +38,7 @@ This ioctl is optional and not all drivers support it. It was introduced
in Linux 2.6.15.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
index cd58a34a7ee8..191dbc144ef7 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-overlay.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_OVERLAY
********************
-NAME
+Name
====
VIDIOC_OVERLAY - Start or stop video overlay
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, const int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
This ioctl is part of the :ref:`video overlay <overlay>` I/O method.
@@ -42,7 +43,7 @@ Drivers do not support :ref:`VIDIOC_STREAMON` or
``V4L2_BUF_TYPE_VIDEO_OVERLAY``.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
index 0f51082f8c93..79076dff46fd 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_PREPARE_BUF
************************
-NAME
+Name
====
VIDIOC_PREPARE_BUF - Prepare a buffer for I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Applications can optionally call the :ref:`VIDIOC_PREPARE_BUF` ioctl to
@@ -45,7 +46,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
index bf41f30cf9c4..9870d243131a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-qbuf.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_QBUF, VIDIOC_DQBUF
*******************************
-NAME
+Name
====
VIDIOC_QBUF - VIDIOC_DQBUF - Exchange a buffer with the driver
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Applications call the ``VIDIOC_QBUF`` ioctl to enqueue an empty
@@ -116,7 +117,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
index 38295fd5f1ad..338b80df5b9b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERY_DV_TIMINGS
*****************************
-NAME
+Name
====
VIDIOC_QUERY_DV_TIMINGS - VIDIOC_SUBDEV_QUERY_DV_TIMINGS - Sense the DV preset received by the current input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_dv_timings *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The hardware may be able to detect the current DV timings automatically,
@@ -61,7 +62,7 @@ found timings with the hardware's capabilities in order to give more
precise feedback to the user.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
index 6454c302644d..32af6f7b5060 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querybuf.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERYBUF
*********************
-NAME
+Name
====
VIDIOC_QUERYBUF - Query the status of a buffer
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_buffer *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
This ioctl is part of the :ref:`streaming <mmap>` I/O method. It can
@@ -68,7 +69,7 @@ The :ref:`struct v4l2_buffer <v4l2-buffer>` structure is specified in
:ref:`buffer`.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
index 406c5eb34034..f0271f834ac1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querycap.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERYCAP
*********************
-NAME
+Name
====
VIDIOC_QUERYCAP - Query device capabilities
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_capability *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
All V4L2 devices support the ``VIDIOC_QUERYCAP`` ioctl. It is used to
@@ -420,7 +421,7 @@ specification the ioctl returns an ``EINVAL`` error code.
``device_caps`` field.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
index 4e0eb7b04fd2..0f27e712eec9 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst
@@ -6,12 +6,13 @@
ioctls VIDIOC_QUERYCTRL, VIDIOC_QUERY_EXT_CTRL and VIDIOC_QUERYMENU
*******************************************************************
-NAME
+Name
====
VIDIOC_QUERYCTRL - VIDIOC_QUERY_EXT_CTRL - VIDIOC_QUERYMENU - Enumerate controls and menu control items
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_queryctrl *argp )
@@ -21,7 +22,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_querymenu *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -33,7 +34,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To query the attributes of a control applications set the ``id`` field
@@ -753,7 +754,7 @@ See also the examples in :ref:`control`.
``V4L2_CTRL_TYPE_BUTTON`` have this flag set.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
index fe540f80ef60..5bf62775c740 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-querystd.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_QUERYSTD
*********************
-NAME
+Name
====
VIDIOC_QUERYSTD - Sense the video standard received by the current input
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, v4l2_std_id *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The hardware may be able to detect the current video standard
@@ -54,7 +55,7 @@ standard is valid they will have to stop streaming, set the new
standard, allocate new buffers and start streaming again.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
index 2e27708fd7a6..c25b0719c2ff 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_REQBUFS
********************
-NAME
+Name
====
VIDIOC_REQBUFS - Initiate Memory Mapping or User Pointer I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_requestbuffers *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
This ioctl is used to initiate :ref:`memory mapped <mmap>`,
@@ -112,7 +113,7 @@ any DMA in progress, an implicit
must set the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
index 068a67e8a523..5fd332a5bfee 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_S_HW_FREQ_SEEK
***************************
-NAME
+Name
====
VIDIOC_S_HW_FREQ_SEEK - Perform a hardware frequency seek
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_hw_freq_seek *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Start a hardware frequency seek from the current frequency. To do this
@@ -155,7 +156,7 @@ error code is returned and no seek takes place.
zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
index 0e6b750f8718..e87500e608e1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-streamon.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_STREAMON, VIDIOC_STREAMOFF
***************************************
-NAME
+Name
====
VIDIOC_STREAMON - VIDIOC_STREAMOFF - Start or stop streaming I/O
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, const int *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The ``VIDIOC_STREAMON`` and ``VIDIOC_STREAMOFF`` ioctl start and stop
@@ -81,7 +82,7 @@ no notion of starting or stopping "now". Buffer timestamps can be used
to synchronize with other events.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
index 0d2b690cf8bc..0aa6482a91a6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL
***************************************
-NAME
+Name
====
VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL - Enumerate frame intervals
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval_enum * argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
This ioctl lets applications enumerate available frame intervals on a
@@ -137,7 +138,7 @@ multiple pads of the same sub-device is not defined.
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
index c52a02df5b16..7a5811b71b68 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_ENUM_FRAME_SIZE
***********************************
-NAME
+Name
====
VIDIOC_SUBDEV_ENUM_FRAME_SIZE - Enumerate media bus frame sizes
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_size_enum * argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
This ioctl allows applications to enumerate all frame sizes supported by
@@ -147,7 +148,7 @@ information about try formats.
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
index 1ff173e502f7..bc0531eb56fa 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_ENUM_MBUS_CODE
**********************************
-NAME
+Name
====
VIDIOC_SUBDEV_ENUM_MBUS_CODE - Enumerate media bus formats
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_mbus_code_enum * argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
To enumerate media bus formats available at a given sub-device pad
@@ -100,7 +101,7 @@ information about the try formats.
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
index 94bffa78c486..690034a391d3 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst
@@ -6,12 +6,13 @@
ioctl VIDIOC_SUBDEV_G_CROP, VIDIOC_SUBDEV_S_CROP
************************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_CROP - VIDIOC_SUBDEV_S_CROP - Get or set the crop rectangle on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_crop *argp )
@@ -19,7 +20,7 @@ SYNOPSIS
.. cpp:function:: int ioctl( int fd, int request, const struct v4l2_subdev_crop *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -31,7 +32,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
**Note**
@@ -114,7 +115,7 @@ modified format should be as close as possible to the original request.
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
index 13615c0d0392..90e2a6635ebc 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_G_FMT, VIDIOC_SUBDEV_S_FMT
**********************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_FMT - VIDIOC_SUBDEV_S_FMT - Get or set the data format on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_format *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls are used to negotiate the frame format at specific subdev
@@ -144,7 +145,7 @@ should be as close as possible to the original request.
- Active formats, applied to the hardware.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
index 05f5bfb3f1ca..d8a1cabbd272 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL
********************************************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_FRAME_INTERVAL - VIDIOC_SUBDEV_S_FRAME_INTERVAL - Get or set the frame interval on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_frame_interval *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -30,7 +31,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
These ioctls are used to get and set the frame interval at specific
@@ -100,7 +101,7 @@ the same sub-device is not defined.
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
index dd0dab7d7e42..50838a4a429e 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBDEV_G_SELECTION, VIDIOC_SUBDEV_S_SELECTION
**********************************************************
-NAME
+Name
====
VIDIOC_SUBDEV_G_SELECTION - VIDIOC_SUBDEV_S_SELECTION - Get or set selection rectangles on a subdev pad
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_subdev_selection *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
The selections are used to configure various image processing
@@ -122,7 +123,7 @@ Selection targets and flags are documented in
the array to zero.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
diff --git a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
index 2ecce157f852..a027f602de3d 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst
@@ -6,18 +6,19 @@
ioctl VIDIOC_SUBSCRIBE_EVENT, VIDIOC_UNSUBSCRIBE_EVENT
******************************************************
-NAME
+Name
====
VIDIOC_SUBSCRIBE_EVENT - VIDIOC_UNSUBSCRIBE_EVENT - Subscribe or unsubscribe event
-SYNOPSIS
+
+Synopsis
========
.. cpp:function:: int ioctl( int fd, int request, struct v4l2_event_subscription *argp )
-ARGUMENTS
+Arguments
=========
``fd``
@@ -29,7 +30,7 @@ ARGUMENTS
``argp``
-DESCRIPTION
+Description
===========
Subscribe or unsubscribe V4L2 event. Subscribed events are dequeued by
@@ -126,7 +127,7 @@ using the :ref:`VIDIOC_DQEVENT` ioctl.
situations like that.
-RETURN VALUE
+Return Value
============
On success 0 is returned, on error -1 and the ``errno`` variable is set
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 10/54] doc-rst: linux_tv: use :cpp:function:: on all syscalls
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (8 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 09/54] doc-rst: linux_tv: don't use uppercases for syscall sections Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 11/54] doc-rst: dmabuf: Fix the cross-reference Mauro Carvalho Chehab
` (44 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Now that we have one syscall per page, using :cpp:function::
cleans up almost all warnings, with is a great thing.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../media/dvb/audio-bilingual-channel-select.rst | 2 +-
.../linux_tv/media/dvb/audio-channel-select.rst | 2 +-
.../linux_tv/media/dvb/audio-clear-buffer.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-continue.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-fclose.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-fopen.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-fwrite.rst | 2 +-
.../linux_tv/media/dvb/audio-get-capabilities.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-get-pts.rst | 2 +-
.../linux_tv/media/dvb/audio-get-status.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-pause.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-play.rst | 2 +-
.../linux_tv/media/dvb/audio-select-source.rst | 2 +-
.../linux_tv/media/dvb/audio-set-attributes.rst | 2 +-
.../linux_tv/media/dvb/audio-set-av-sync.rst | 2 +-
.../linux_tv/media/dvb/audio-set-bypass-mode.rst | 2 +-
.../linux_tv/media/dvb/audio-set-ext-id.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-set-id.rst | 2 +-
.../linux_tv/media/dvb/audio-set-karaoke.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-set-mixer.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-set-mute.rst | 2 +-
.../linux_tv/media/dvb/audio-set-streamtype.rst | 2 +-
Documentation/linux_tv/media/dvb/audio-stop.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-add-pid.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-fclose.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-fopen.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-fread.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-fwrite.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-get-caps.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-get-event.rst | 2 +-
.../linux_tv/media/dvb/dmx-get-pes-pids.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-get-stc.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-remove-pid.rst | 2 +-
.../linux_tv/media/dvb/dmx-set-buffer-size.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-set-filter.rst | 2 +-
.../linux_tv/media/dvb/dmx-set-pes-filter.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-set-source.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-start.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx-stop.rst | 2 +-
.../linux_tv/media/dvb/fe-diseqc-send-burst.rst | 2 +-
.../linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst | 20 +++++++++++---------
.../media/dvb/fe-dishnetwork-send-legacy-cmd.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-get-event.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-get-frontend.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-read-ber.rst | 2 +-
.../linux_tv/media/dvb/fe-read-signal-strength.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-read-snr.rst | 2 +-
.../media/dvb/fe-read-uncorrected-blocks.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-set-frontend.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-set-tone.rst | 2 +-
Documentation/linux_tv/media/dvb/fe-set-voltage.rst | 2 +-
.../linux_tv/media/dvb/video-clear-buffer.rst | 2 +-
Documentation/linux_tv/media/dvb/video-command.rst | 2 +-
Documentation/linux_tv/media/dvb/video-continue.rst | 2 +-
.../linux_tv/media/dvb/video-fast-forward.rst | 2 +-
Documentation/linux_tv/media/dvb/video-fclose.rst | 2 +-
Documentation/linux_tv/media/dvb/video-fopen.rst | 2 +-
Documentation/linux_tv/media/dvb/video-freeze.rst | 2 +-
Documentation/linux_tv/media/dvb/video-fwrite.rst | 2 +-
.../linux_tv/media/dvb/video-get-capabilities.rst | 2 +-
Documentation/linux_tv/media/dvb/video-get-event.rst | 2 +-
.../linux_tv/media/dvb/video-get-frame-count.rst | 2 +-
.../linux_tv/media/dvb/video-get-frame-rate.rst | 2 +-
Documentation/linux_tv/media/dvb/video-get-navi.rst | 2 +-
Documentation/linux_tv/media/dvb/video-get-pts.rst | 2 +-
Documentation/linux_tv/media/dvb/video-get-size.rst | 2 +-
.../linux_tv/media/dvb/video-get-status.rst | 2 +-
Documentation/linux_tv/media/dvb/video-play.rst | 2 +-
.../linux_tv/media/dvb/video-select-source.rst | 2 +-
.../linux_tv/media/dvb/video-set-attributes.rst | 2 +-
Documentation/linux_tv/media/dvb/video-set-blank.rst | 2 +-
.../linux_tv/media/dvb/video-set-display-format.rst | 2 +-
.../linux_tv/media/dvb/video-set-format.rst | 2 +-
.../linux_tv/media/dvb/video-set-highlight.rst | 2 +-
Documentation/linux_tv/media/dvb/video-set-id.rst | 2 +-
.../linux_tv/media/dvb/video-set-spu-palette.rst | 2 +-
Documentation/linux_tv/media/dvb/video-set-spu.rst | 2 +-
.../linux_tv/media/dvb/video-set-streamtype.rst | 2 +-
.../linux_tv/media/dvb/video-set-system.rst | 2 +-
.../linux_tv/media/dvb/video-slowmotion.rst | 2 +-
.../linux_tv/media/dvb/video-stillpicture.rst | 2 +-
Documentation/linux_tv/media/dvb/video-stop.rst | 2 +-
.../linux_tv/media/dvb/video-try-command.rst | 2 +-
.../linux_tv/media/v4l/vidioc-g-priority.rst | 4 ++--
84 files changed, 95 insertions(+), 93 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
index 841c9759d5e0..dbe20ff38e83 100644
--- a/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
+++ b/Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst
@@ -15,7 +15,7 @@ AUDIO_BILINGUAL_CHANNEL_SELECT
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_BILINGUAL_CHANNEL_SELECT, audio_channel_select_t)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-channel-select.rst b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
index f2dd79903c49..69df4c0f2fb2 100644
--- a/Documentation/linux_tv/media/dvb/audio-channel-select.rst
+++ b/Documentation/linux_tv/media/dvb/audio-channel-select.rst
@@ -15,7 +15,7 @@ AUDIO_CHANNEL_SELECT
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_CHANNEL_SELECT, audio_channel_select_t)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
index a576c6b160a4..a3dec29bdc69 100644
--- a/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
+++ b/Documentation/linux_tv/media/dvb/audio-clear-buffer.rst
@@ -15,7 +15,7 @@ AUDIO_CLEAR_BUFFER
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_CLEAR_BUFFER)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-continue.rst b/Documentation/linux_tv/media/dvb/audio-continue.rst
index b513a39f0935..053627dd61e7 100644
--- a/Documentation/linux_tv/media/dvb/audio-continue.rst
+++ b/Documentation/linux_tv/media/dvb/audio-continue.rst
@@ -15,7 +15,7 @@ AUDIO_CONTINUE
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_CONTINUE)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-fclose.rst b/Documentation/linux_tv/media/dvb/audio-fclose.rst
index e515fb353a14..e5d4225cd9d7 100644
--- a/Documentation/linux_tv/media/dvb/audio-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fclose.rst
@@ -15,7 +15,7 @@ DVB audio close()
Synopsis
--------
-.. c:function:: int close(int fd)
+.. cpp:function:: int close(int fd)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-fopen.rst b/Documentation/linux_tv/media/dvb/audio-fopen.rst
index 46a15950439f..ec3b23aa79b3 100644
--- a/Documentation/linux_tv/media/dvb/audio-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fopen.rst
@@ -15,7 +15,7 @@ DVB audio open()
Synopsis
--------
-.. c:function:: int open(const char *deviceName, int flags)
+.. cpp:function:: int open(const char *deviceName, int flags)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-fwrite.rst b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
index f9307053064f..ca95b9be0c2a 100644
--- a/Documentation/linux_tv/media/dvb/audio-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/audio-fwrite.rst
@@ -15,7 +15,7 @@ DVB audio write()
Synopsis
--------
-.. c:function:: size_t write(int fd, const void *buf, size_t count)
+.. cpp:function:: size_t write(int fd, const void *buf, size_t count)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
index 8b6fdc664f9d..e274a8d53785 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-capabilities.rst
@@ -15,7 +15,7 @@ AUDIO_GET_CAPABILITIES
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_GET_CAPABILITIES, unsigned int *cap)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-get-pts.rst b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
index 246c78c003de..5f875508b833 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-pts.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-pts.rst
@@ -15,7 +15,7 @@ AUDIO_GET_PTS
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_GET_PTS, __u64 *pts)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-get-status.rst b/Documentation/linux_tv/media/dvb/audio-get-status.rst
index b0a550af87b3..cbd822773d85 100644
--- a/Documentation/linux_tv/media/dvb/audio-get-status.rst
+++ b/Documentation/linux_tv/media/dvb/audio-get-status.rst
@@ -15,7 +15,7 @@ AUDIO_GET_STATUS
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_GET_STATUS, struct audio_status *status)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-pause.rst b/Documentation/linux_tv/media/dvb/audio-pause.rst
index 86652c3bca06..9ca263e90c6c 100644
--- a/Documentation/linux_tv/media/dvb/audio-pause.rst
+++ b/Documentation/linux_tv/media/dvb/audio-pause.rst
@@ -15,7 +15,7 @@ AUDIO_PAUSE
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_PAUSE)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-play.rst b/Documentation/linux_tv/media/dvb/audio-play.rst
index 1af708375821..db4d7203acc5 100644
--- a/Documentation/linux_tv/media/dvb/audio-play.rst
+++ b/Documentation/linux_tv/media/dvb/audio-play.rst
@@ -15,7 +15,7 @@ AUDIO_PLAY
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_PLAY)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_PLAY)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-select-source.rst b/Documentation/linux_tv/media/dvb/audio-select-source.rst
index 3e873d9cb345..b806d806a46f 100644
--- a/Documentation/linux_tv/media/dvb/audio-select-source.rst
+++ b/Documentation/linux_tv/media/dvb/audio-select-source.rst
@@ -15,7 +15,7 @@ AUDIO_SELECT_SOURCE
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_SELECT_SOURCE, audio_stream_source_t source)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
index 43ff50279742..18667cea2cdf 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-attributes.rst
@@ -15,7 +15,7 @@ AUDIO_SET_ATTRIBUTES
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
+.. cpp:function:: int ioctl(fd, int request = AUDIO_SET_ATTRIBUTES, audio_attributes_t attr )
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
index 4ecfb75d28f1..6f7e26fa4cd1 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-av-sync.rst
@@ -15,7 +15,7 @@ AUDIO_SET_AV_SYNC
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_SET_AV_SYNC, boolean state)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
index b21d142ec31c..30bcaca14c3f 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst
@@ -15,7 +15,7 @@ AUDIO_SET_BYPASS_MODE
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_SET_BYPASS_MODE, boolean mode)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
index 1b5b8893a00b..049414db8ef6 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-ext-id.rst
@@ -15,7 +15,7 @@ AUDIO_SET_EXT_ID
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
+.. cpp:function:: int ioctl(fd, int request = AUDIO_SET_EXT_ID, int id)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-id.rst b/Documentation/linux_tv/media/dvb/audio-set-id.rst
index fed99eae52cb..a664dc1955cb 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-id.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-id.rst
@@ -15,7 +15,7 @@ AUDIO_SET_ID
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_SET_ID, int id)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
index ebb2d41bbec3..b55f8380b9cd 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-karaoke.rst
@@ -15,7 +15,7 @@ AUDIO_SET_KARAOKE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
+.. cpp:function:: int ioctl(fd, int request = AUDIO_SET_KARAOKE, audio_karaoke_t *karaoke)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
index ce4b2a63917e..67821729c2b6 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-mixer.rst
@@ -15,7 +15,7 @@ AUDIO_SET_MIXER
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_SET_MIXER, audio_mixer_t *mix)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-mute.rst b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
index a2469267508b..ebaba95ee278 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-mute.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-mute.rst
@@ -15,7 +15,7 @@ AUDIO_SET_MUTE
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_SET_MUTE, boolean state)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
index 4b13c9b9dffe..dfb9a6c00d88 100644
--- a/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
+++ b/Documentation/linux_tv/media/dvb/audio-set-streamtype.rst
@@ -15,7 +15,7 @@ AUDIO_SET_STREAMTYPE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
+.. cpp:function:: int ioctl(fd, int request = AUDIO_SET_STREAMTYPE, int type)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/audio-stop.rst b/Documentation/linux_tv/media/dvb/audio-stop.rst
index d9430978096f..449127e3f2aa 100644
--- a/Documentation/linux_tv/media/dvb/audio-stop.rst
+++ b/Documentation/linux_tv/media/dvb/audio-stop.rst
@@ -15,7 +15,7 @@ AUDIO_STOP
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = AUDIO_STOP)
+.. cpp:function:: int ioctl(int fd, int request = AUDIO_STOP)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
index 37f5ee43d523..6343035653ac 100644
--- a/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-add-pid.rst
@@ -15,7 +15,7 @@ DMX_ADD_PID
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
+.. cpp:function:: int ioctl(fd, int request = DMX_ADD_PID, __u16 *)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-fclose.rst b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
index e442881481a2..f54c2a1220c1 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fclose.rst
@@ -15,7 +15,7 @@ DVB demux close()
Synopsis
--------
-.. c:function:: int close(int fd)
+.. cpp:function:: int close(int fd)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-fopen.rst b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
index 7e640fa860c3..76dbb42713ad 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fopen.rst
@@ -15,7 +15,7 @@ DVB demux open()
Synopsis
--------
-.. c:function:: int open(const char *deviceName, int flags)
+.. cpp:function:: int open(const char *deviceName, int flags)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-fread.rst b/Documentation/linux_tv/media/dvb/dmx-fread.rst
index 92f7a0632766..d25b19e4f696 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fread.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fread.rst
@@ -15,7 +15,7 @@ DVB demux read()
Synopsis
--------
-.. c:function:: size_t read(int fd, void *buf, size_t count)
+.. cpp:function:: size_t read(int fd, void *buf, size_t count)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
index 8d2632205c29..9efd81a1b5c8 100644
--- a/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-fwrite.rst
@@ -15,7 +15,7 @@ DVB demux write()
Synopsis
--------
-.. c:function:: ssize_t write(int fd, const void *buf, size_t count)
+.. cpp:function:: ssize_t write(int fd, const void *buf, size_t count)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
index 20e3d6e55d30..d0549eb7fbd3 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-caps.rst
@@ -15,7 +15,7 @@ DMX_GET_CAPS
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
+.. cpp:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-event.rst b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
index 81a7c7fedd47..6a7550c63bb5 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-event.rst
@@ -15,7 +15,7 @@ DMX_GET_EVENT
Synopsis
--------
-.. c:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
+.. cpp:function:: int ioctl( int fd, int request = DMX_GET_EVENT, struct dmx_event *ev)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
index 8b1fbf5d2c81..ba5d30c913c8 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst
@@ -15,7 +15,7 @@ DMX_GET_PES_PIDS
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
+.. cpp:function:: int ioctl(fd, int request = DMX_GET_PES_PIDS, __u16[5])
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
index 616c745a0418..bd477bb67082 100644
--- a/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-get-stc.rst
@@ -15,7 +15,7 @@ DMX_GET_STC
Synopsis
--------
-.. c:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
+.. cpp:function:: int ioctl( int fd, int request = DMX_GET_STC, struct dmx_stc *stc)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
index ed1a49ce9fc2..c8f038b40074 100644
--- a/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-remove-pid.rst
@@ -15,7 +15,7 @@ DMX_REMOVE_PID
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
+.. cpp:function:: int ioctl(fd, int request = DMX_REMOVE_PID, __u16 *)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
index 012b9e9792be..8ae48cf39cda 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst
@@ -15,7 +15,7 @@ DMX_SET_BUFFER_SIZE
Synopsis
--------
-.. c:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
+.. cpp:function:: int ioctl( int fd, int request = DMX_SET_BUFFER_SIZE, unsigned long size)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
index d079d8b39597..8c929fa9b98c 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-filter.rst
@@ -15,7 +15,7 @@ DMX_SET_FILTER
Synopsis
--------
-.. c:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
+.. cpp:function:: int ioctl( int fd, int request = DMX_SET_FILTER, struct dmx_sct_filter_params *params)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
index 910869ebdefd..addc321011ce 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst
@@ -15,7 +15,7 @@ DMX_SET_PES_FILTER
Synopsis
--------
-.. c:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
+.. cpp:function:: int ioctl( int fd, int request = DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-set-source.rst b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
index 7aa4dfe3cdc5..99a8d5c82756 100644
--- a/Documentation/linux_tv/media/dvb/dmx-set-source.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-set-source.rst
@@ -15,7 +15,7 @@ DMX_SET_SOURCE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
+.. cpp:function:: int ioctl(fd, int request = DMX_SET_SOURCE, dmx_source_t *)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-start.rst b/Documentation/linux_tv/media/dvb/dmx-start.rst
index cc316d00343d..9835d1e78400 100644
--- a/Documentation/linux_tv/media/dvb/dmx-start.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-start.rst
@@ -15,7 +15,7 @@ DMX_START
Synopsis
--------
-.. c:function:: int ioctl( int fd, int request = DMX_START)
+.. cpp:function:: int ioctl( int fd, int request = DMX_START)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/dmx-stop.rst b/Documentation/linux_tv/media/dvb/dmx-stop.rst
index f9157dd6a8fe..7e4bf09fc83e 100644
--- a/Documentation/linux_tv/media/dvb/dmx-stop.rst
+++ b/Documentation/linux_tv/media/dvb/dmx-stop.rst
@@ -15,7 +15,7 @@ DMX_STOP
Synopsis
--------
-.. c:function:: int ioctl( int fd, int request = DMX_STOP)
+.. cpp:function:: int ioctl( int fd, int request = DMX_STOP)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
index c022cc290067..11d441c6f237 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
@@ -15,7 +15,7 @@ FE_DISEQC_SEND_BURST - Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite se
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
+.. cpp:function:: int ioctl( int fd, int request, enum fe_sec_mini_cmd *tone )
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
index dc83b4f2e586..58a5e6ac10bd 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst
@@ -37,17 +37,11 @@ Description
Sends a DiSEqC command to the antenna subsystem.
-
-Return Value
-============
-
-On success 0 is returned, on error -1 and the ``errno`` variable is set
-appropriately. The generic error codes are described at the
-:ref:`Generic Error Codes <gen-errors>` chapter.
-
-
.. _dvb-diseqc-master-cmd:
+struct dvb_diseqc_master_cmd
+============================
+
.. flat-table:: struct dvb_diseqc_master_cmd
:header-rows: 0
:stub-columns: 0
@@ -69,3 +63,11 @@ appropriately. The generic error codes are described at the
- msg_len
- Length of the DiSEqC message. Valid values are 3 to 6
+
+Return Value
+============
+
+On success 0 is returned, on error -1 and the ``errno`` variable is set
+appropriately. The generic error codes are described at the
+:ref:`Generic Error Codes <gen-errors>` chapter.
+
diff --git a/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst b/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
index 4b60a42dd52c..9f71b39de0c2 100644
--- a/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
+++ b/Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst
@@ -15,7 +15,7 @@ FE_DISHNETWORK_SEND_LEGACY_CMD
Synopsis
========
-.. c:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
+.. cpp:function:: int ioctl(int fd, int request = FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-get-event.rst b/Documentation/linux_tv/media/dvb/fe-get-event.rst
index 79beb1b9da3b..ffa3d04c6bd4 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-event.rst
@@ -15,7 +15,7 @@ FE_GET_EVENT
Synopsis
========
-.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
+.. cpp:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-get-frontend.rst b/Documentation/linux_tv/media/dvb/fe-get-frontend.rst
index fdf0d1440add..5d2df808df18 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-frontend.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-frontend.rst
@@ -15,7 +15,7 @@ FE_GET_FRONTEND
Synopsis
========
-.. c:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
+.. cpp:function:: int ioctl(int fd, int request = FE_GET_FRONTEND, struct dvb_frontend_parameters *p)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-read-ber.rst b/Documentation/linux_tv/media/dvb/fe-read-ber.rst
index 3262441385ff..c2b5b417f5fb 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-ber.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-ber.rst
@@ -14,7 +14,7 @@ FE_READ_BER
Synopsis
========
-.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
+.. cpp:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst b/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
index fcaadcb537fb..0cdee2effc97 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst
@@ -15,7 +15,7 @@ FE_READ_SIGNAL_STRENGTH
Synopsis
========
-.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
+.. cpp:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-read-snr.rst b/Documentation/linux_tv/media/dvb/fe-read-snr.rst
index 837af2de9f6f..5394f9ae90f4 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-snr.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-snr.rst
@@ -15,7 +15,7 @@ FE_READ_SNR
Synopsis
========
-.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
+.. cpp:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst b/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
index 6b753846a008..5c29c058dfdc 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst
@@ -15,7 +15,7 @@ FE_READ_UNCORRECTED_BLOCKS
Synopsis
========
-.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
+.. cpp:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
index 4e66da0af6fd..7cb70c38d534 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-frontend.rst
@@ -15,7 +15,7 @@ FE_SET_FRONTEND
Synopsis
========
-.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
+.. cpp:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-set-tone.rst b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
index 12aedb69395d..16bf6b73f8d5 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-tone.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
@@ -15,7 +15,7 @@ FE_SET_TONE - Sets/resets the generation of the continuous 22kHz tone.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, enum fe_sec_tone_mode *tone )
+.. cpp:function:: int ioctl( int fd, int request, enum fe_sec_tone_mode *tone )
Arguments
diff --git a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
index ec8dbf4e266c..517f79bdbb4b 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-voltage.rst
@@ -15,7 +15,7 @@ FE_SET_VOLTAGE - Allow setting the DC level sent to the antenna subsystem.
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
+.. cpp:function:: int ioctl( int fd, int request, enum fe_sec_voltage *voltage )
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
index dd227ad85546..7c85aa06f013 100644
--- a/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
+++ b/Documentation/linux_tv/media/dvb/video-clear-buffer.rst
@@ -15,7 +15,7 @@ VIDEO_CLEAR_BUFFER
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_CLEAR_BUFFER)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-command.rst b/Documentation/linux_tv/media/dvb/video-command.rst
index 42a98a47e323..b1634f722cbd 100644
--- a/Documentation/linux_tv/media/dvb/video-command.rst
+++ b/Documentation/linux_tv/media/dvb/video-command.rst
@@ -15,7 +15,7 @@ VIDEO_COMMAND
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
+.. cpp:function:: int ioctl(int fd, int request = VIDEO_COMMAND, struct video_command *cmd)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-continue.rst b/Documentation/linux_tv/media/dvb/video-continue.rst
index 2a6444a4f4dc..c5acc094986f 100644
--- a/Documentation/linux_tv/media/dvb/video-continue.rst
+++ b/Documentation/linux_tv/media/dvb/video-continue.rst
@@ -15,7 +15,7 @@ VIDEO_CONTINUE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_CONTINUE)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-fast-forward.rst b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
index 0b3a27a22d30..db338e9f5379 100644
--- a/Documentation/linux_tv/media/dvb/video-fast-forward.rst
+++ b/Documentation/linux_tv/media/dvb/video-fast-forward.rst
@@ -15,7 +15,7 @@ VIDEO_FAST_FORWARD
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_FAST_FORWARD, int nFrames)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-fclose.rst b/Documentation/linux_tv/media/dvb/video-fclose.rst
index b4dd5ea676b9..ebeaade0c351 100644
--- a/Documentation/linux_tv/media/dvb/video-fclose.rst
+++ b/Documentation/linux_tv/media/dvb/video-fclose.rst
@@ -15,7 +15,7 @@ dvb video close()
Synopsis
--------
-.. c:function:: int close(int fd)
+.. cpp:function:: int close(int fd)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-fopen.rst b/Documentation/linux_tv/media/dvb/video-fopen.rst
index 31d4d62b2c7c..9e5471557b83 100644
--- a/Documentation/linux_tv/media/dvb/video-fopen.rst
+++ b/Documentation/linux_tv/media/dvb/video-fopen.rst
@@ -15,7 +15,7 @@ dvb video open()
Synopsis
--------
-.. c:function:: int open(const char *deviceName, int flags)
+.. cpp:function:: int open(const char *deviceName, int flags)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-freeze.rst b/Documentation/linux_tv/media/dvb/video-freeze.rst
index 12e04df990b7..d3d0dc31281a 100644
--- a/Documentation/linux_tv/media/dvb/video-freeze.rst
+++ b/Documentation/linux_tv/media/dvb/video-freeze.rst
@@ -15,7 +15,7 @@ VIDEO_FREEZE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_FREEZE)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_FREEZE)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-fwrite.rst b/Documentation/linux_tv/media/dvb/video-fwrite.rst
index da03db4be8de..045038f4181e 100644
--- a/Documentation/linux_tv/media/dvb/video-fwrite.rst
+++ b/Documentation/linux_tv/media/dvb/video-fwrite.rst
@@ -15,7 +15,7 @@ dvb video write()
Synopsis
--------
-.. c:function:: size_t write(int fd, const void *buf, size_t count)
+.. cpp:function:: size_t write(int fd, const void *buf, size_t count)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
index 5515dd40a1c1..94cbbba478a8 100644
--- a/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-capabilities.rst
@@ -15,7 +15,7 @@ VIDEO_GET_CAPABILITIES
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_GET_CAPABILITIES, unsigned int *cap)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-event.rst b/Documentation/linux_tv/media/dvb/video-get-event.rst
index d43459915179..a1484a226518 100644
--- a/Documentation/linux_tv/media/dvb/video-get-event.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-event.rst
@@ -15,7 +15,7 @@ VIDEO_GET_EVENT
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_GET_EVENT, struct video_event *ev)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
index a55f7a1d52ac..4ff100c2ee95 100644
--- a/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-count.rst
@@ -15,7 +15,7 @@ VIDEO_GET_FRAME_COUNT
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
+.. cpp:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_COUNT, __u64 *pts)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
index a137b6589599..131def962305 100644
--- a/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-frame-rate.rst
@@ -15,7 +15,7 @@ VIDEO_GET_FRAME_RATE
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
+.. cpp:function:: int ioctl(int fd, int request = VIDEO_GET_FRAME_RATE, unsigned int *rate)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-navi.rst b/Documentation/linux_tv/media/dvb/video-get-navi.rst
index ccb2552722f0..6c3034fe5fa2 100644
--- a/Documentation/linux_tv/media/dvb/video-get-navi.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-navi.rst
@@ -15,7 +15,7 @@ VIDEO_GET_NAVI
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_GET_NAVI , video_navi_pack_t *navipack)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-pts.rst b/Documentation/linux_tv/media/dvb/video-get-pts.rst
index c1ad9576963d..082612243bbb 100644
--- a/Documentation/linux_tv/media/dvb/video-get-pts.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-pts.rst
@@ -15,7 +15,7 @@ VIDEO_GET_PTS
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
+.. cpp:function:: int ioctl(int fd, int request = VIDEO_GET_PTS, __u64 *pts)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-size.rst b/Documentation/linux_tv/media/dvb/video-get-size.rst
index 70fb266e3ed8..c75e3c47c471 100644
--- a/Documentation/linux_tv/media/dvb/video-get-size.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-size.rst
@@ -15,7 +15,7 @@ VIDEO_GET_SIZE
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
+.. cpp:function:: int ioctl(int fd, int request = VIDEO_GET_SIZE, video_size_t *size)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-get-status.rst b/Documentation/linux_tv/media/dvb/video-get-status.rst
index 5fd5b37942ec..ab9c2236df7e 100644
--- a/Documentation/linux_tv/media/dvb/video-get-status.rst
+++ b/Documentation/linux_tv/media/dvb/video-get-status.rst
@@ -15,7 +15,7 @@ VIDEO_GET_STATUS
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_GET_STATUS, struct video_status *status)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-play.rst b/Documentation/linux_tv/media/dvb/video-play.rst
index 103d0ad3341a..943c4b755372 100644
--- a/Documentation/linux_tv/media/dvb/video-play.rst
+++ b/Documentation/linux_tv/media/dvb/video-play.rst
@@ -15,7 +15,7 @@ VIDEO_PLAY
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_PLAY)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_PLAY)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-select-source.rst b/Documentation/linux_tv/media/dvb/video-select-source.rst
index f03c544668f5..0ee0d03dbeb2 100644
--- a/Documentation/linux_tv/media/dvb/video-select-source.rst
+++ b/Documentation/linux_tv/media/dvb/video-select-source.rst
@@ -15,7 +15,7 @@ VIDEO_SELECT_SOURCE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SELECT_SOURCE, video_stream_source_t source)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-attributes.rst b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
index 9de0d9c7c9ca..326c5c876e80 100644
--- a/Documentation/linux_tv/media/dvb/video-set-attributes.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-attributes.rst
@@ -15,7 +15,7 @@ VIDEO_SET_ATTRIBUTES
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_ATTRIBUTE ,video_attributes_t vattr)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-blank.rst b/Documentation/linux_tv/media/dvb/video-set-blank.rst
index d8b94c9b56b9..142ea8817380 100644
--- a/Documentation/linux_tv/media/dvb/video-set-blank.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-blank.rst
@@ -15,7 +15,7 @@ VIDEO_SET_BLANK
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_BLANK, boolean mode)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-display-format.rst b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
index c1fb7c75b4a8..2061ab064977 100644
--- a/Documentation/linux_tv/media/dvb/video-set-display-format.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-display-format.rst
@@ -15,7 +15,7 @@ VIDEO_SET_DISPLAY_FORMAT
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_DISPLAY_FORMAT, video_display_format_t format)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-format.rst b/Documentation/linux_tv/media/dvb/video-set-format.rst
index 257a3c2a4627..53d66ec462ca 100644
--- a/Documentation/linux_tv/media/dvb/video-set-format.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-format.rst
@@ -15,7 +15,7 @@ VIDEO_SET_FORMAT
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_FORMAT, video_format_t format)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-highlight.rst b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
index 6ff11af71355..374f5d895b4d 100644
--- a/Documentation/linux_tv/media/dvb/video-set-highlight.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-highlight.rst
@@ -15,7 +15,7 @@ VIDEO_SET_HIGHLIGHT
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_HIGHLIGHT ,video_highlight_t *vhilite)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-id.rst b/Documentation/linux_tv/media/dvb/video-set-id.rst
index 61993ab354ca..9c002d5399ad 100644
--- a/Documentation/linux_tv/media/dvb/video-set-id.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-id.rst
@@ -15,7 +15,7 @@ VIDEO_SET_ID
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
+.. cpp:function:: int ioctl(int fd, int request = VIDEO_SET_ID, int id)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
index ae9e0da5fd0b..4b80b6f56219 100644
--- a/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-spu-palette.rst
@@ -15,7 +15,7 @@ VIDEO_SET_SPU_PALETTE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_SPU_PALETTE, video_spu_palette_t *palette )
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-spu.rst b/Documentation/linux_tv/media/dvb/video-set-spu.rst
index ce2860574f20..a6f6924f10c4 100644
--- a/Documentation/linux_tv/media/dvb/video-set-spu.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-spu.rst
@@ -15,7 +15,7 @@ VIDEO_SET_SPU
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_SPU , video_spu_t *spu)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
index a2055369f0cd..75b2e7a6e829 100644
--- a/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-streamtype.rst
@@ -15,7 +15,7 @@ VIDEO_SET_STREAMTYPE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_STREAMTYPE, int type)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-set-system.rst b/Documentation/linux_tv/media/dvb/video-set-system.rst
index f84906a7d1f4..9ae0df1f5813 100644
--- a/Documentation/linux_tv/media/dvb/video-set-system.rst
+++ b/Documentation/linux_tv/media/dvb/video-set-system.rst
@@ -15,7 +15,7 @@ VIDEO_SET_SYSTEM
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SET_SYSTEM , video_system_t system)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-slowmotion.rst b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
index c8cc85af590b..905712844f6a 100644
--- a/Documentation/linux_tv/media/dvb/video-slowmotion.rst
+++ b/Documentation/linux_tv/media/dvb/video-slowmotion.rst
@@ -15,7 +15,7 @@ VIDEO_SLOWMOTION
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_SLOWMOTION, int nFrames)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-stillpicture.rst b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
index 053cdbba4ed4..ed3a2f53b998 100644
--- a/Documentation/linux_tv/media/dvb/video-stillpicture.rst
+++ b/Documentation/linux_tv/media/dvb/video-stillpicture.rst
@@ -15,7 +15,7 @@ VIDEO_STILLPICTURE
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_STILLPICTURE, struct video_still_picture *sp)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-stop.rst b/Documentation/linux_tv/media/dvb/video-stop.rst
index 4e7fbab4b8bc..ad8d59e06004 100644
--- a/Documentation/linux_tv/media/dvb/video-stop.rst
+++ b/Documentation/linux_tv/media/dvb/video-stop.rst
@@ -15,7 +15,7 @@ VIDEO_STOP
Synopsis
--------
-.. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
+.. cpp:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode)
Arguments
diff --git a/Documentation/linux_tv/media/dvb/video-try-command.rst b/Documentation/linux_tv/media/dvb/video-try-command.rst
index be21fb01bd0f..df96c2d7fc6b 100644
--- a/Documentation/linux_tv/media/dvb/video-try-command.rst
+++ b/Documentation/linux_tv/media/dvb/video-try-command.rst
@@ -15,7 +15,7 @@ VIDEO_TRY_COMMAND
Synopsis
--------
-.. c:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
+.. cpp:function:: int ioctl(int fd, int request = VIDEO_TRY_COMMAND, struct video_command *cmd)
Arguments
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
index 4419195661f1..9f774ce400a4 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-priority.rst
@@ -15,9 +15,9 @@ VIDIOC_G_PRIORITY - VIDIOC_S_PRIORITY - Query or request the access priority ass
Synopsis
========
-.. c:function:: int ioctl( int fd, int request, enum v4l2_priority *argp )
+.. cpp:function:: int ioctl( int fd, int request, enum v4l2_priority *argp )
-.. c:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp )
+.. cpp:function:: int ioctl( int fd, int request, const enum v4l2_priority *argp )
Arguments
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 11/54] doc-rst: dmabuf: Fix the cross-reference
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (9 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 10/54] doc-rst: linux_tv: use :cpp:function:: on all syscalls Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 12/54] doc-rst: dev-overlay: fix the last warning Mauro Carvalho Chehab
` (43 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Fixes this warning:
Documentation/linux_tv/media/v4l/dmabuf.rst:150: WARNING: undefined label: vidioc_dqbuf (if the link has no caption the label must precede a section header)
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/dmabuf.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/linux_tv/media/v4l/dmabuf.rst b/Documentation/linux_tv/media/v4l/dmabuf.rst
index 0b2113778cc9..474d8c021507 100644
--- a/Documentation/linux_tv/media/v4l/dmabuf.rst
+++ b/Documentation/linux_tv/media/v4l/dmabuf.rst
@@ -149,7 +149,7 @@ outputted buffers.
Drivers implementing DMABUF importing I/O must support the
:ref:`VIDIOC_REQBUFS <VIDIOC_REQBUFS>`, :ref:`VIDIOC_QBUF <VIDIOC_QBUF>`,
-:ref:`VIDIOC_DQBUF <VIDIOC_DQBUF>`, :ref:`VIDIOC_STREAMON
+:ref:`VIDIOC_DQBUF <VIDIOC_QBUF>`, :ref:`VIDIOC_STREAMON
<VIDIOC_STREAMON>` and :ref:`VIDIOC_STREAMOFF <VIDIOC_STREAMON>` ioctls,
and the :ref:`select() <func-select>` and :ref:`poll() <func-poll>`
functions.
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 12/54] doc-rst: dev-overlay: fix the last warning
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (10 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 11/54] doc-rst: dmabuf: Fix the cross-reference Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 13/54] doc-rst: dvbapi: Fix conversion issues Mauro Carvalho Chehab
` (42 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Fixes this warning:
Documentation/linux_tv/media/v4l/dev-overlay.rst:247: WARNING: Title underline too short.
struct v4l2_clip [4]_
----------------
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/dev-overlay.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/linux_tv/media/v4l/dev-overlay.rst b/Documentation/linux_tv/media/v4l/dev-overlay.rst
index e481d677aa3f..bed00bf34982 100644
--- a/Documentation/linux_tv/media/v4l/dev-overlay.rst
+++ b/Documentation/linux_tv/media/v4l/dev-overlay.rst
@@ -244,7 +244,7 @@ exceeded are undefined. [3]_
.. _v4l2-clip:
struct v4l2_clip [4]_
-----------------
+---------------------
``struct v4l2_rect c``
Coordinates of the clipping rectangle, relative to the top, left
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 13/54] doc-rst: dvbapi: Fix conversion issues
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (11 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 12/54] doc-rst: dev-overlay: fix the last warning Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 14/54] doc-rst: fix intro_files/dvbstb.png image Mauro Carvalho Chehab
` (41 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The conversion of this file didn't happen too well. We want
the items numbered, and format it just like what we did with
part 1 of the document.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/dvb/dvbapi.rst | 25 ++++++++++++++++---------
1 file changed, 16 insertions(+), 9 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/dvbapi.rst b/Documentation/linux_tv/media/dvb/dvbapi.rst
index ad800404ae9f..3a7d39e98fa3 100644
--- a/Documentation/linux_tv/media/dvb/dvbapi.rst
+++ b/Documentation/linux_tv/media/dvb/dvbapi.rst
@@ -12,6 +12,7 @@ LINUX DVB API
.. toctree::
:maxdepth: 1
+ :numbered:
intro
frontend
@@ -32,28 +33,34 @@ LINUX DVB API
Revision and Copyright
**********************
+Authors:
-:author: Metzler Ralph (*J. K.*)
-:address: rjkm@metzlerbros.de
+- J. K. Metzler, Ralph <rjkm@metzlerbros.de>
-:author: Metzler Marcus (*O. C.*)
-:address: rjkm@metzlerbros.de
+ - Original author of the DVB API documentation.
-:author: Chehab Mauro (*Carvalho*)
-:address: m.chehab@samsung.com
-:contrib: Ported document to Docbook XML.
+- O. C. Metzler, Marcus <rjkm@metzlerbros.de>
-**Copyright** |copy| 2002, 2003 : Convergence GmbH
+ - Original author of the DVB API documentation.
+
+- Carvalho Chehab, Mauro <m.chehab@kernel.org>
+
+ - Ported document to Docbook XML, addition of DVBv5 API, documentation gaps fix.
+
+**Copyright** |copy| 2002-2003 : Convergence GmbH
**Copyright** |copy| 2009-2016 : Mauro Carvalho Chehab
+****************
+Revision History
+****************
+
:revision: 2.1.0 / 2015-05-29 (*mcc*)
DocBook improvements and cleanups, in order to document the system calls
on a more standard way and provide more description about the current
DVB API.
-
:revision: 2.0.4 / 2011-05-06 (*mcc*)
Add more information about DVB APIv5, better describing the frontend
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 14/54] doc-rst: fix intro_files/dvbstb.png image
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (12 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 13/54] doc-rst: dvbapi: Fix conversion issues Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 15/54] doc-rst: dvb/intro: Better show the needed include blocks Mauro Carvalho Chehab
` (40 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The png image was not base64 decoded correctly.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../linux_tv/media/dvb/intro_files/dvbstb.png | Bin 22703 -> 22655 bytes
1 file changed, 0 insertions(+), 0 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/intro_files/dvbstb.png b/Documentation/linux_tv/media/dvb/intro_files/dvbstb.png
index 5836ea94eba4ec4fd13a83e89ef86b312cc04c02..9b8f372e7afd9d016854973ba705dcdfbd1bbf13 100644
GIT binary patch
delta 116
zcmZ3#k@5cq#tjYZ%&xwHo7>q}ax=MxZ8j4=%*x{G=H|AUQBs<j#nr{dWwVM*HzS0#
zUAB&&87RBiM)w#KlWX{94uf}0tRO`poBtbq0SX0e{%N{}naMSD@@C6POs;;Ly{#&M
NT3lT>pYnXl2LO%FCVBt>
delta 164
zcmeyrfpPst#tjYZ><J03zJUn|o158Ja<c(BVL-N?@L^UCAluE&4aoZ{A<YcpxwyCh
zc_K31j0oOh**boZ5nzQXy2qG6MuY>Ez0rTi#0k+90_5H|`T~{;0<y1~Zea!~3r$Fv
a+-*4t#PkCS%Ue}|jdFDba%Oox<pTgz-8pao
--
2.7.4
^ permalink raw reply [flat|nested] 56+ messages in thread
* [PATCH 15/54] doc-rst: dvb/intro: Better show the needed include blocks
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (13 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 14/54] doc-rst: fix intro_files/dvbstb.png image Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 16/54] doc-rst: intro: remove obsolete headers Mauro Carvalho Chehab
` (39 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The include blocks were not properly displayed. Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/dvb/intro.rst | 18 ------------------
1 file changed, 18 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/intro.rst b/Documentation/linux_tv/media/dvb/intro.rst
index 06b568b80f7a..72992940a057 100644
--- a/Documentation/linux_tv/media/dvb/intro.rst
+++ b/Documentation/linux_tv/media/dvb/intro.rst
@@ -160,34 +160,16 @@ partial path like:
#include <linux/dvb/audio.h>
-
-.. code-block:: c
-
#include <linux/dvb/ca.h>
-
-.. code-block:: c
-
#include <linux/dvb/dmx.h>
-
-.. code-block:: c
-
#include <linux/dvb/frontend.h>
-
-.. code-block:: c
-
#include <linux/dvb/net.h>
-
-.. code-block:: c
-
#include <linux/dvb/osd.h>
-
-.. code-block:: c
-
#include <linux/dvb/video.h>
To enable applications to support different API version, an additional
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 16/54] doc-rst: intro: remove obsolete headers
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (14 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 15/54] doc-rst: dvb/intro: Better show the needed include blocks Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 17/54] doc-rst: media-controller: fix conversion issues Mauro Carvalho Chehab
` (38 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The video, audio and OSD APIs are obsolete. V4L2 should be
used instead. So, remove them from this intro item.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/dvb/intro.rst | 5 -----
1 file changed, 5 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/intro.rst b/Documentation/linux_tv/media/dvb/intro.rst
index 72992940a057..b61081d00a9f 100644
--- a/Documentation/linux_tv/media/dvb/intro.rst
+++ b/Documentation/linux_tv/media/dvb/intro.rst
@@ -158,8 +158,6 @@ partial path like:
.. code-block:: c
- #include <linux/dvb/audio.h>
-
#include <linux/dvb/ca.h>
#include <linux/dvb/dmx.h>
@@ -168,9 +166,6 @@ partial path like:
#include <linux/dvb/net.h>
- #include <linux/dvb/osd.h>
-
- #include <linux/dvb/video.h>
To enable applications to support different API version, an additional
include file ``linux/dvb/version.h`` exists, which defines the constant
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 17/54] doc-rst: media-controller: fix conversion issues
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (15 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 16/54] doc-rst: intro: remove obsolete headers Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 18/54] doc-rst: media-controller: missing credits Mauro Carvalho Chehab
` (37 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Make it look just like v4l and DVB parts.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/mediactl/media-controller.rst | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/Documentation/linux_tv/media/mediactl/media-controller.rst b/Documentation/linux_tv/media/mediactl/media-controller.rst
index 49fb76cafcab..8b8af483c5e9 100644
--- a/Documentation/linux_tv/media/mediactl/media-controller.rst
+++ b/Documentation/linux_tv/media/mediactl/media-controller.rst
@@ -15,6 +15,7 @@ Media Controller
.. toctree::
:maxdepth: 1
+ :numbered:
media-controller-intro
media-controller-model
@@ -45,13 +46,18 @@ Function Reference
Revision and Copyright
**********************
+Authors:
-:author: Pinchart Laurent
-:address: laurent.pinchart@ideasonboard.com
-:contrib: Initial version.
+- Pinchart, Laurent <laurent.pinchart@ideasonboard.com>
+
+ - Initial version.
**Copyright** 2010 : Laurent Pinchart
+****************
+Revision History
+****************
+
:revision: 1.0.0 / 2010-11-10 (*lp*)
Initial revision
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 18/54] doc-rst: media-controller: missing credits
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (16 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 17/54] doc-rst: media-controller: fix conversion issues Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 19/54] doc-rst: media-controller.rst: add missing copy symbol Mauro Carvalho Chehab
` (36 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
When I wrote the MC next gen patches, I also improved the media
controller documentation and added documentation for
MEDIA_IOC_G_TOPOLOGY, but I forgot to add the credits on that
time.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/mediactl/media-controller.rst | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/Documentation/linux_tv/media/mediactl/media-controller.rst b/Documentation/linux_tv/media/mediactl/media-controller.rst
index 8b8af483c5e9..1877d68044b8 100644
--- a/Documentation/linux_tv/media/mediactl/media-controller.rst
+++ b/Documentation/linux_tv/media/mediactl/media-controller.rst
@@ -52,12 +52,19 @@ Authors:
- Initial version.
+- Carvalho Chehab, Mauro <mchehab@kernel.org>
+
+ - MEDIA_IOC_G_TOPOLOGY documentation and documentation improvements.
+
**Copyright** 2010 : Laurent Pinchart
+**Copyright** 2015-2016 : Mauro Carvalho Chehab
****************
Revision History
****************
+:revision: 1.1.0 / 2015-12-12 (*mcc*)
+
:revision: 1.0.0 / 2010-11-10 (*lp*)
Initial revision
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 19/54] doc-rst: media-controller.rst: add missing copy symbol
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (17 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 18/54] doc-rst: media-controller: missing credits Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 20/54] doc-rst: media-controller-model: fix a typo Mauro Carvalho Chehab
` (35 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Just like V4L and DVB parts, add the copyright symbol.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/mediactl/media-controller.rst | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/Documentation/linux_tv/media/mediactl/media-controller.rst b/Documentation/linux_tv/media/mediactl/media-controller.rst
index 1877d68044b8..8758308997a7 100644
--- a/Documentation/linux_tv/media/mediactl/media-controller.rst
+++ b/Documentation/linux_tv/media/mediactl/media-controller.rst
@@ -1,5 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
+.. include:: <isonum.txt>
+
.. _media_common:
####################
@@ -56,8 +58,9 @@ Authors:
- MEDIA_IOC_G_TOPOLOGY documentation and documentation improvements.
-**Copyright** 2010 : Laurent Pinchart
-**Copyright** 2015-2016 : Mauro Carvalho Chehab
+**Copyright** |copy| 2010 : Laurent Pinchart
+
+**Copyright** |copy| 2015-2016 : Mauro Carvalho Chehab
****************
Revision History
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 20/54] doc-rst: media-controller-model: fix a typo
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (18 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 19/54] doc-rst: media-controller.rst: add missing copy symbol Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 21/54] doc-rst: mediactl: fix some wrong cross references Mauro Carvalho Chehab
` (34 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Remove a 'm' at the end of the last phrase.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/mediactl/media-controller-model.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/linux_tv/media/mediactl/media-controller-model.rst b/Documentation/linux_tv/media/mediactl/media-controller-model.rst
index 7be58aecb882..558273cf9570 100644
--- a/Documentation/linux_tv/media/mediactl/media-controller-model.rst
+++ b/Documentation/linux_tv/media/mediactl/media-controller-model.rst
@@ -32,4 +32,4 @@ are:
from a source pad to a sink pad.
- An **interface link** is a point-to-point bidirectional control
- connection between a Linux Kernel interface and an entity.m
+ connection between a Linux Kernel interface and an entity.
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 21/54] doc-rst: mediactl: fix some wrong cross references
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (19 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 20/54] doc-rst: media-controller-model: fix a typo Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 22/54] doc-rst: media-ioc-g-topology: Fix tables Mauro Carvalho Chehab
` (33 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Those cross references should point to media control syscalls,
and not to V4L ones.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/mediactl/media-func-close.rst | 2 +-
Documentation/linux_tv/media/mediactl/media-func-ioctl.rst | 4 ++--
Documentation/linux_tv/media/mediactl/media-func-open.rst | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/linux_tv/media/mediactl/media-func-close.rst b/Documentation/linux_tv/media/mediactl/media-func-close.rst
index 3f3d9bb1f32a..39ef70ac8656 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-close.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-close.rst
@@ -40,7 +40,7 @@ are freed. The device configuration remain unchanged.
Return Value
============
-:ref:`close() <func-close>` returns 0 on success. On error, -1 is returned, and
+:ref:`close() <media-func-close>` returns 0 on success. On error, -1 is returned, and
``errno`` is set appropriately. Possible error codes are:
EBADF
diff --git a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
index 1b28e2d20de4..9d1b23133edf 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-ioctl.rst
@@ -40,8 +40,8 @@ Arguments
Description
===========
-The :ref:`ioctl() <func-ioctl>` function manipulates media device parameters.
-The argument ``fd`` must be an open file descriptor.
+The :ref:`ioctl() <media-func-ioctl>` function manipulates media device
+parameters. The argument ``fd`` must be an open file descriptor.
The ioctl ``request`` code specifies the media function to be called. It
has encoded in it whether the argument is an input, output or read/write
diff --git a/Documentation/linux_tv/media/mediactl/media-func-open.rst b/Documentation/linux_tv/media/mediactl/media-func-open.rst
index 43b9ddc5c38f..2b2ecd85b995 100644
--- a/Documentation/linux_tv/media/mediactl/media-func-open.rst
+++ b/Documentation/linux_tv/media/mediactl/media-func-open.rst
@@ -37,7 +37,7 @@ Arguments
Description
===========
-To open a media device applications call :ref:`open() <func-open>` with the
+To open a media device applications call :ref:`open() <media-func-open>` with the
desired device name. The function has no side effects; the device
configuration remain unchanged.
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 22/54] doc-rst: media-ioc-g-topology: Fix tables
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (20 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 21/54] doc-rst: mediactl: fix some wrong cross references Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 23/54] doc-rst: media-ioc-enum-entities: better format the table Mauro Carvalho Chehab
` (32 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The tables were not properly converted. It looked a little
ackward already at DocBook, but the conversion made it worse.
Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../media/mediactl/media-ioc-g-topology.rst | 63 +++-------------------
1 file changed, 6 insertions(+), 57 deletions(-)
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
index badcdf6133e2..1f2d530aa284 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst
@@ -54,6 +54,7 @@ desired arrays with the media graph elements.
.. flat-table:: struct media_v2_topology
:header-rows: 0
:stub-columns: 0
+ :widths: 1 2 8
- .. row 1
@@ -62,8 +63,6 @@ desired arrays with the media graph elements.
- ``topology_version``
- -
- -
- Version of the media graph topology. When the graph is created,
this field starts with zero. Every time a graph element is added
or removed, this field is incremented.
@@ -74,8 +73,6 @@ desired arrays with the media graph elements.
- ``num_entities``
- -
- -
- Number of entities in the graph
- .. row 3
@@ -84,8 +81,6 @@ desired arrays with the media graph elements.
- ``ptr_entities``
- -
- -
- A pointer to a memory area where the entities array will be
stored, converted to a 64-bits integer. It can be zero. if zero,
the ioctl won't store the entities. It will just update
@@ -97,8 +92,6 @@ desired arrays with the media graph elements.
- ``num_interfaces``
- -
- -
- Number of interfaces in the graph
- .. row 5
@@ -107,8 +100,6 @@ desired arrays with the media graph elements.
- ``ptr_interfaces``
- -
- -
- A pointer to a memory area where the interfaces array will be
stored, converted to a 64-bits integer. It can be zero. if zero,
the ioctl won't store the interfaces. It will just update
@@ -120,8 +111,6 @@ desired arrays with the media graph elements.
- ``num_pads``
- -
- -
- Total number of pads in the graph
- .. row 7
@@ -130,8 +119,6 @@ desired arrays with the media graph elements.
- ``ptr_pads``
- -
- -
- A pointer to a memory area where the pads array will be stored,
converted to a 64-bits integer. It can be zero. if zero, the ioctl
won't store the pads. It will just update ``num_pads``
@@ -142,8 +129,6 @@ desired arrays with the media graph elements.
- ``num_links``
- -
- -
- Total number of data and interface links in the graph
- .. row 9
@@ -152,8 +137,6 @@ desired arrays with the media graph elements.
- ``ptr_links``
- -
- -
- A pointer to a memory area where the links array will be stored,
converted to a 64-bits integer. It can be zero. if zero, the ioctl
won't store the links. It will just update ``num_links``
@@ -165,6 +148,7 @@ desired arrays with the media graph elements.
.. flat-table:: struct media_v2_entity
:header-rows: 0
:stub-columns: 0
+ :widths: 1 2 8
- .. row 1
@@ -173,8 +157,6 @@ desired arrays with the media graph elements.
- ``id``
- -
- -
- Unique ID for the entity.
- .. row 2
@@ -183,8 +165,6 @@ desired arrays with the media graph elements.
- ``name``\ [64]
- -
- -
- Entity name as an UTF-8 NULL-terminated string.
- .. row 3
@@ -193,8 +173,6 @@ desired arrays with the media graph elements.
- ``function``
- -
- -
- Entity main function, see :ref:`media-entity-type` for details.
- .. row 4
@@ -213,7 +191,7 @@ desired arrays with the media graph elements.
.. flat-table:: struct media_v2_interface
:header-rows: 0
:stub-columns: 0
-
+ :widths: 1 2 8
- .. row 1
@@ -221,8 +199,6 @@ desired arrays with the media graph elements.
- ``id``
- -
- -
- Unique ID for the interface.
- .. row 2
@@ -231,8 +207,6 @@ desired arrays with the media graph elements.
- ``intf_type``
- -
- -
- Interface type, see :ref:`media-intf-type` for details.
- .. row 3
@@ -241,8 +215,6 @@ desired arrays with the media graph elements.
- ``flags``
- -
- -
- Interface flags. Currently unused.
- .. row 4
@@ -251,8 +223,6 @@ desired arrays with the media graph elements.
- ``reserved``\ [9]
- -
- -
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -262,8 +232,6 @@ desired arrays with the media graph elements.
- ``devnode``
- -
- -
- Used only for device node interfaces. See
:ref:`media-v2-intf-devnode` for details..
@@ -274,6 +242,7 @@ desired arrays with the media graph elements.
.. flat-table:: struct media_v2_interface
:header-rows: 0
:stub-columns: 0
+ :widths: 1 2 8
- .. row 1
@@ -282,8 +251,6 @@ desired arrays with the media graph elements.
- ``major``
- -
- -
- Device node major number.
- .. row 2
@@ -292,8 +259,6 @@ desired arrays with the media graph elements.
- ``minor``
- -
- -
- Device node minor number.
@@ -303,6 +268,7 @@ desired arrays with the media graph elements.
.. flat-table:: struct media_v2_pad
:header-rows: 0
:stub-columns: 0
+ :widths: 1 2 8
- .. row 1
@@ -311,8 +277,6 @@ desired arrays with the media graph elements.
- ``id``
- -
- -
- Unique ID for the pad.
- .. row 2
@@ -321,8 +285,6 @@ desired arrays with the media graph elements.
- ``entity_id``
- -
- -
- Unique ID for the entity where this pad belongs.
- .. row 3
@@ -331,8 +293,6 @@ desired arrays with the media graph elements.
- ``flags``
- -
- -
- Pad flags, see :ref:`media-pad-flag` for more details.
- .. row 4
@@ -341,8 +301,6 @@ desired arrays with the media graph elements.
- ``reserved``\ [9]
- -
- -
- Reserved for future extensions. Drivers and applications must set
this array to zero.
@@ -353,6 +311,7 @@ desired arrays with the media graph elements.
.. flat-table:: struct media_v2_pad
:header-rows: 0
:stub-columns: 0
+ :widths: 1 2 8
- .. row 1
@@ -361,8 +320,6 @@ desired arrays with the media graph elements.
- ``id``
- -
- -
- Unique ID for the pad.
- .. row 2
@@ -371,8 +328,6 @@ desired arrays with the media graph elements.
- ``source_id``
- -
- -
- On pad to pad links: unique ID for the source pad.
On interface to entity links: unique ID for the interface.
@@ -383,8 +338,6 @@ desired arrays with the media graph elements.
- ``sink_id``
- -
- -
- On pad to pad links: unique ID for the sink pad.
On interface to entity links: unique ID for the entity.
@@ -395,8 +348,6 @@ desired arrays with the media graph elements.
- ``flags``
- -
- -
- Link flags, see :ref:`media-link-flag` for more details.
- .. row 5
@@ -405,8 +356,6 @@ desired arrays with the media graph elements.
- ``reserved``\ [5]
- -
- -
- Reserved for future extensions. Drivers and applications must set
this array to zero.
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 23/54] doc-rst: media-ioc-enum-entities: better format the table
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (21 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 22/54] doc-rst: media-ioc-g-topology: Fix tables Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 24/54] doc-rst: gen-errors: Improve table layout Mauro Carvalho Chehab
` (31 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Add a :widths: at the flat-table, to improve the visual.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
index f11c45ad7278..ae88f46b3a9e 100644
--- a/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
+++ b/Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst
@@ -54,6 +54,7 @@ id's until they get an error.
.. flat-table:: struct media_entity_desc
:header-rows: 0
:stub-columns: 0
+ :widths: 1 1 1 1 8
- .. row 1
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 24/54] doc-rst: gen-errors: Improve table layout
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (22 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 23/54] doc-rst: media-ioc-enum-entities: better format the table Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 25/54] doc-rst: remote_controllers: fix conversion issues Mauro Carvalho Chehab
` (30 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Add a :widths: at the flat-table, to make it to look nicer.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/gen-errors.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/Documentation/linux_tv/media/gen-errors.rst b/Documentation/linux_tv/media/gen-errors.rst
index 6dc76b2461df..6cd5d26f32ab 100644
--- a/Documentation/linux_tv/media/gen-errors.rst
+++ b/Documentation/linux_tv/media/gen-errors.rst
@@ -12,6 +12,7 @@ Generic Error Codes
.. flat-table:: Generic error codes
:header-rows: 0
:stub-columns: 0
+ :widths: 1 16
- .. row 1
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 25/54] doc-rst: remote_controllers: fix conversion issues
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (23 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 24/54] doc-rst: gen-errors: Improve table layout Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 26/54] doc-rst: Rename the title of the Digital TV section Mauro Carvalho Chehab
` (29 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Make it look like V4L, DVB and MC docbooks initial page.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/rc/remote_controllers.rst | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/Documentation/linux_tv/media/rc/remote_controllers.rst b/Documentation/linux_tv/media/rc/remote_controllers.rst
index 4b36e992f59a..bccceb1e28c3 100644
--- a/Documentation/linux_tv/media/rc/remote_controllers.rst
+++ b/Documentation/linux_tv/media/rc/remote_controllers.rst
@@ -1,5 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
+.. include:: <isonum.txt>
+
.. _remotes:
#####################
@@ -15,6 +17,7 @@ Remote Controllers
.. toctree::
:maxdepth: 1
+ :numbered:
Remote_controllers_Intro
remote_controllers_sysfs_nodes
@@ -27,12 +30,17 @@ Remote Controllers
Revision and Copyright
**********************
+Authors:
-:author: Chehab Mauro (*Carvalho*)
-:address: m.chehab@samsung.com
-:contrib: Initial version.
+- Carvalho Chehab, Mauro <mchehab@kernel.org>
-**Copyright** 2009-2014 : Mauro Carvalho Chehab
+ - Initial version.
+
+**Copyright** |copy| 2009-2016 : Mauro Carvalho Chehab
+
+****************
+Revision History
+****************
:revision: 3.15 / 2014-02-06 (*mcc*)
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 26/54] doc-rst: Rename the title of the Digital TV section
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (24 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 25/54] doc-rst: remote_controllers: fix conversion issues Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 27/54] doc-rst: v4l2: Rename the V4L2 API title Mauro Carvalho Chehab
` (28 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The Digital TV section is ackward for two reasons:
1) it is the only one with everything in upper case;
2) its name is associated with the European digital TV standard.
Rename the part name, and add a notice that it refers to what's
known as "DVB API".
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/dvb/dvbapi.rst | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/dvbapi.rst b/Documentation/linux_tv/media/dvb/dvbapi.rst
index 3a7d39e98fa3..60fb3d46b1d6 100644
--- a/Documentation/linux_tv/media/dvb/dvbapi.rst
+++ b/Documentation/linux_tv/media/dvb/dvbapi.rst
@@ -4,9 +4,12 @@
.. _dvbapi:
-#############
-LINUX DVB API
-#############
+##############
+Digital TV API
+##############
+
+**NOTE:** This API is also known as **DVB API**, although it is generic
+enough to support all digital TV standards.
**Version 5.10**
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 27/54] doc-rst: v4l2: Rename the V4L2 API title
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (25 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 26/54] doc-rst: Rename the title of the Digital TV section Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 28/54] doc-rst: linux_tv/index: Rename the book name Mauro Carvalho Chehab
` (27 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The V4L2 is the only part of the doc that has the word "Specification"
and mentions its version on the title.
Having the version there was important in the past, while we were
getting rid of V4L version 1. But, as v1 is long gone, all it lasts
is history (with is, btw, covered on the spec). So, no need to keep
the version on its title.
So, rename it, to be more generic and look like the remaining
of the document.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/v4l2.rst | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/v4l2.rst b/Documentation/linux_tv/media/v4l/v4l2.rst
index 9284446e3cfa..301f95b5bdc6 100644
--- a/Documentation/linux_tv/media/v4l/v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/v4l2.rst
@@ -3,9 +3,11 @@
.. include:: <isonum.txt>
.. _v4l2spec:
-#####################################
-Video for Linux Two API Specification
-#####################################
+###################
+Video for Linux API
+###################
+
+This part describes the Video for Linux API version 2 (V4L2 API) specification.
**Revision 4.5**
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 28/54] doc-rst: linux_tv/index: Rename the book name
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (26 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 27/54] doc-rst: v4l2: Rename the V4L2 API title Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 29/54] doc-rst: add parse-headers.pl script Mauro Carvalho Chehab
` (26 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
There's no need for all caps at its name. As the book title is
now showing at the top of each page, let's use Camel Case, to
make it less bold.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/index.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/linux_tv/index.rst b/Documentation/linux_tv/index.rst
index 4815ad6fc6b9..67b3ef6ec3d7 100644
--- a/Documentation/linux_tv/index.rst
+++ b/Documentation/linux_tv/index.rst
@@ -3,7 +3,7 @@
.. include:: <isonum.txt>
##############################
-LINUX MEDIA INFRASTRUCTURE API
+Linux Media Infrastructure API
##############################
**Copyright** |copy| 2009-2016 : LinuxTV Developers
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 29/54] doc-rst: add parse-headers.pl script
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (27 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 28/54] doc-rst: linux_tv/index: Rename the book name Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 30/54] doc-rst: auto-build the frontend.h.rst Mauro Carvalho Chehab
` (25 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This script parses a header file and converts it into a
parsed-literal block, creating references for ioctls,
defines, typedefs, enums and structs.
It also allow an external file to modify the rules, in
order to fix the expressions.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 290 ++++++++++++++++++++++++++++++++++
1 file changed, 290 insertions(+)
create mode 100755 Documentation/sphinx/parse-headers.pl
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
new file mode 100755
index 000000000000..287f6459e13a
--- /dev/null
+++ b/Documentation/sphinx/parse-headers.pl
@@ -0,0 +1,290 @@
+#!/usr/bin/perl
+use strict;
+use Text::Tabs;
+
+# Uncomment if debug is needed
+#use Data::Dumper;
+
+# change to 1 to generate some debug prints
+my $debug = 0;
+
+if (scalar @ARGV < 2 || scalar @ARGV > 3) {
+ die "Usage:\n\t$0 <file in> <file out> [<exceptions file>]\n";
+}
+
+my ($file_in, $file_out, $file_exceptions) = @ARGV;
+
+my $data;
+my %ioctls;
+my %defines;
+my %typedefs;
+my %enums;
+my %enum_symbols;
+my %structs;
+
+#
+# read the file and get identifiers
+#
+
+my $is_enum = 0;
+open IN, $file_in or die "Can't open $file_in";
+while (<IN>) {
+ $data .= $_;
+
+ if ($is_enum && m/^\s*([^\s\}\,\=]+)\s*[\,=]?/) {
+ my $s = $1;
+ my $n = $1;
+ $n =~ tr/A-Z/a-z/;
+ $n =~ tr/_/-/;
+
+ $enum_symbols{$s} = $n;
+
+ $is_enum = 0 if ($is_enum && m/\}/);
+ next;
+ }
+ $is_enum = 0 if ($is_enum && m/\}/);
+
+ if (m/^\s*#\s*define\s+([_A-Z]\S+)\s+_IO/) {
+ my $s = $1;
+ my $n = $1;
+ $n =~ tr/A-Z/a-z/;
+
+ $ioctls{$s} = $n;
+ next;
+ }
+
+ if (m/^\s*#\s*define\s+([_A-Z]\S+)\s+/) {
+ my $s = $1;
+ my $n = $1;
+ $n =~ tr/A-Z/a-z/;
+ $n =~ tr/_/-/;
+
+ $defines{$s} = $n;
+ next;
+ }
+
+ if (m/^\s*typedef\s+.*\s+([_\w]\S+);/) {
+ my $s = $1;
+ my $n = $1;
+ $n =~ tr/A-Z/a-z/;
+ $n =~ tr/_/-/;
+
+ $typedefs{$s} = $n;
+ next;
+ }
+ if (m/^\s*enum\s+(\S+)\s+\{/ || m/^\s*enum\s+(\S+)$/) {
+ my $s = $1;
+ my $n = $1;
+ $n =~ tr/A-Z/a-z/;
+ $n =~ tr/_/-/;
+
+ $enums{$s} = $n;
+
+ $is_enum = $1;
+ next;
+ }
+ if (m/^\s*struct\s+([_A-Za-z_]\S+)\s+\{/ || m/^\s*struct\s+([A-Za-z_]\S+)$/) {
+ my $s = $1;
+ my $n = $1;
+ $n =~ tr/A-Z/a-z/;
+ $n =~ tr/_/-/;
+
+ $structs{$s} = $n;
+ next;
+ }
+}
+close IN;
+
+#
+# Handle multi-line typedefs
+#
+
+my @matches = $data =~ m/typedef\s+struct\s+\S+\s*\{[^\}]+\}\s*(\S+)\s*\;/g;
+foreach my $m (@matches) {
+ my $s = $1;
+ my $n = $1;
+ $n =~ tr/A-Z/a-z/;
+ $n =~ tr/_/-/;
+
+ $typedefs{$s} = $n;
+ next;
+}
+
+#
+# Handle exceptions, if any
+#
+
+if ($file_exceptions) {
+ open IN, $file_exceptions or die "Can't read $file_exceptions";
+ while (<IN>) {
+ next if (m/^\s*$/ || m/^\s*#/);
+
+ # Parsers to ignore a symbol
+
+ if (m/^ignore\s+ioctl\s+(\S+)/) {
+ delete $ioctls{$1} if (exists($ioctls{$1}));
+ next;
+ }
+ if (m/^ignore\s+define\s+(\S+)/) {
+ delete $defines{$1} if (exists($defines{$1}));
+ next;
+ }
+ if (m/^ignore\s+typedef\s+(\S+)/) {
+ delete $typedefs{$1} if (exists($typedefs{$1}));
+ next;
+ }
+ if (m/^ignore\s+enum\s+(\S+)/) {
+ delete $enums{$1} if (exists($enums{$1}));
+ next;
+ }
+ if (m/^ignore\s+struct\s+(\S+)/) {
+ delete $structs{$1} if (exists($structs{$1}));
+ next;
+ }
+
+ # Parsers to replace a symbol
+
+ if (m/^replace\s+ioctl\s+(\S+)\s+(\S+)/) {
+ $ioctls{$1} = $2 if (exists($ioctls{$1}));
+ next;
+ }
+ if (m/^replace\s+define\s+(\S+)\s+(\S+)/) {
+ $defines{$1} = $2 if (exists($defines{$1}));
+ next;
+ }
+ if (m/^replace\s+typedef\s+(\S+)\s+(\S+)/) {
+ $typedefs{$1} = $2 if (exists($typedefs{$1}));
+ next;
+ }
+ if (m/^replace\s+enum\s+(\S+)\s+(\S+)/) {
+ $enums{$1} = $2 if (exists($enums{$1}));
+ next;
+ }
+ if (m/^replace\s+symbol\s+(\S+)\s+(\S+)/) {
+ $enum_symbols{$1} = $2 if (exists($enum_symbols{$1}));
+ next;
+ }
+ if (m/^replace\s+struct\s+(\S+)\s+(\S+)/) {
+ $structs{$1} = $2 if (exists($structs{$1}));
+ next;
+ }
+
+ die "Can't parse $file_exceptions: $_";
+ }
+}
+
+if ($debug) {
+ print Data::Dumper->Dump([\%ioctls], [qw(*ioctls)]) if (%ioctls);
+ print Data::Dumper->Dump([\%typedefs], [qw(*typedefs)]) if (%typedefs);
+ print Data::Dumper->Dump([\%enums], [qw(*enums)]) if (%enums);
+ print Data::Dumper->Dump([\%structs], [qw(*structs)]) if (%structs);
+ print Data::Dumper->Dump([\%defines], [qw(*defines)]) if (%defines);
+ print Data::Dumper->Dump([\%enum_symbols], [qw(*enum_symbols)]) if (%enum_symbols);
+}
+
+#
+# Align block
+#
+$data = expand($data);
+$data = " " . $data;
+$data =~ s/\n/\n /g;
+$data =~ s/\n\s+$/\n/g;
+$data =~ s/\n\s+\n/\n\n/g;
+
+#
+# Add escape codes for special characters
+#
+$data =~ s,([\_\`\*\<\>\&\\\\:\/]),\\$1,g;
+
+#
+# Add references
+#
+
+my $separators = "[\n \t\,\)\=\:\{\}\;]";
+
+foreach my $r (keys %ioctls) {
+ my $n = $ioctls{$r};
+
+ my $s = ":ref:`$r <$n>`";
+
+ $r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
+
+ print "$r -> $s\n" if ($debug);
+
+ $data =~ s/([\s])($r)($separators)/$1$s$3/g;
+}
+
+foreach my $r (keys %defines) {
+ my $n = $defines{$r};
+
+ my $s = ":ref:`$r <$n>`";
+
+ $r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
+
+ print "$r -> $s\n" if ($debug);
+
+ $data =~ s/([\s])($r)($separators)/$1$s$3/g;
+}
+
+foreach my $r (keys %enum_symbols) {
+ my $n = $enum_symbols{$r};
+
+ my $s = ":ref:`$r <$n>`";
+
+ $r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
+
+ print "$r -> $s\n" if ($debug);
+
+ $data =~ s/([\s])($r)($separators)/$1$s$3/g;
+}
+
+foreach my $r (keys %enums) {
+ my $n = $enums{$r};
+
+ my $s = ":ref:`enum $r <$n>`";
+
+ $r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
+
+ print "$r -> $s\n" if ($debug);
+
+ $data =~ s/enum\s+($r)($separators)/$s$2/g;
+}
+
+foreach my $r (keys %structs) {
+ my $n = $structs{$r};
+
+ my $s = ":ref:`struct $r <$n>`";
+
+ $r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
+
+ print "$r -> $s\n" if ($debug);
+
+ $data =~ s/struct\s+($r)($separators)/$s$2/g;
+}
+
+foreach my $r (keys %typedefs) {
+ my $n = $typedefs{$r};
+
+ my $s = ":ref:`$r <$n>`";
+
+ $r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
+
+ print "$r -> $s\n" if ($debug);
+
+ $data =~ s/([\s\(\,\=])($r)($separators)/$1$s$3/g;
+}
+
+#
+# Generate output file
+#
+
+my $title = $file_in;
+$title =~ s,.*/,,;
+
+open OUT, "> $file_out" or die "Can't open $file_out";
+print OUT ".. -*- coding: utf-8; mode: rst -*-\n\n";
+print OUT "$title\n";
+print OUT "=" x length($title);
+print OUT "\n\n.. parsed-literal::\n\n";
+print OUT $data;
+close OUT;
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 30/54] doc-rst: auto-build the frontend.h.rst
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (28 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 29/54] doc-rst: add parse-headers.pl script Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 31/54] doc-rst: parse-headers: improve delimiters to detect symbols Mauro Carvalho Chehab
` (24 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This file is auto-generated with DocBook, from the uapi header.
Do the same with Sphinx.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/Makefile.sphinx | 1 +
Documentation/linux_tv/Makefile | 12 +
Documentation/linux_tv/frontend.h.rst | 609 -----------------------
Documentation/linux_tv/frontend.h.rst.exceptions | 47 ++
4 files changed, 60 insertions(+), 609 deletions(-)
create mode 100644 Documentation/linux_tv/Makefile
delete mode 100644 Documentation/linux_tv/frontend.h.rst
create mode 100644 Documentation/linux_tv/frontend.h.rst.exceptions
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index 810c11f0d37f..37cec114254e 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -35,6 +35,7 @@ quiet_cmd_sphinx = SPHINX $@
cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2
htmldocs:
+ $(MAKE) -C $(srctree)/Documentation/linux_tv $@
$(call cmd,sphinx,html)
pdfdocs:
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
new file mode 100644
index 000000000000..d5570193ea30
--- /dev/null
+++ b/Documentation/linux_tv/Makefile
@@ -0,0 +1,12 @@
+# Generate the *.h.rst files from uAPI headers
+
+PARSER = ../sphinx/parse-headers.pl
+UAPI = ../../include/uapi/linux
+
+htmldocs: frontend.h.rst
+
+frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h frontend.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/frontend.h $@ frontend.h.rst.exceptions
+
+clean:
+ -rm frontend.h.rst
diff --git a/Documentation/linux_tv/frontend.h.rst b/Documentation/linux_tv/frontend.h.rst
deleted file mode 100644
index 51dbf2ab883d..000000000000
--- a/Documentation/linux_tv/frontend.h.rst
+++ /dev/null
@@ -1,609 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: frontend.h
-================
-
-.. code-block:: c
-
- /*
- * frontend.h
- *
- * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de>
- * Ralph Metzler <ralph@convergence.de>
- * Holger Waechtler <holger@convergence.de>
- * Andre Draszik <ad@convergence.de>
- * for convergence integrated media GmbH
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
- #ifndef _DVBFRONTEND_H_
- #define _DVBFRONTEND_H_
-
- #include <linux/types.h>
-
- enum fe_type {
- FE_QPSK,
- FE_QAM,
- FE_OFDM,
- FE_ATSC
- };
-
- enum fe_caps {
- FE_IS_STUPID = 0,
- FE_CAN_INVERSION_AUTO = 0x1,
- FE_CAN_FEC_1_2 = 0x2,
- FE_CAN_FEC_2_3 = 0x4,
- FE_CAN_FEC_3_4 = 0x8,
- FE_CAN_FEC_4_5 = 0x10,
- FE_CAN_FEC_5_6 = 0x20,
- FE_CAN_FEC_6_7 = 0x40,
- FE_CAN_FEC_7_8 = 0x80,
- FE_CAN_FEC_8_9 = 0x100,
- FE_CAN_FEC_AUTO = 0x200,
- FE_CAN_QPSK = 0x400,
- FE_CAN_QAM_16 = 0x800,
- FE_CAN_QAM_32 = 0x1000,
- FE_CAN_QAM_64 = 0x2000,
- FE_CAN_QAM_128 = 0x4000,
- FE_CAN_QAM_256 = 0x8000,
- FE_CAN_QAM_AUTO = 0x10000,
- FE_CAN_TRANSMISSION_MODE_AUTO = 0x20000,
- FE_CAN_BANDWIDTH_AUTO = 0x40000,
- FE_CAN_GUARD_INTERVAL_AUTO = 0x80000,
- FE_CAN_HIERARCHY_AUTO = 0x100000,
- FE_CAN_8VSB = 0x200000,
- FE_CAN_16VSB = 0x400000,
- FE_HAS_EXTENDED_CAPS = 0x800000, /* We need more bitspace for newer APIs, indicate this. */
- FE_CAN_MULTISTREAM = 0x4000000, /* frontend supports multistream filtering */
- FE_CAN_TURBO_FEC = 0x8000000, /* frontend supports "turbo fec modulation" */
- FE_CAN_2G_MODULATION = 0x10000000, /* frontend supports "2nd generation modulation" (DVB-S2) */
- FE_NEEDS_BENDING = 0x20000000, /* not supported anymore, don't use (frontend requires frequency bending) */
- FE_CAN_RECOVER = 0x40000000, /* frontend can recover from a cable unplug automatically */
- FE_CAN_MUTE_TS = 0x80000000 /* frontend can stop spurious TS data output */
- };
-
- struct dvb_frontend_info {
- char name[128];
- enum fe_type type; /* DEPRECATED. Use DTV_ENUM_DELSYS instead */
- __u32 frequency_min;
- __u32 frequency_max;
- __u32 frequency_stepsize;
- __u32 frequency_tolerance;
- __u32 symbol_rate_min;
- __u32 symbol_rate_max;
- __u32 symbol_rate_tolerance; /* ppm */
- __u32 notifier_delay; /* DEPRECATED */
- enum fe_caps caps;
- };
-
-
- /**
- * Check out the DiSEqC bus spec available on http://www.eutelsat.org/ for
- * the meaning of this struct...
- */
- struct dvb_diseqc_master_cmd {
- __u8 msg [6]; /* { framing, address, command, data [3] } */
- __u8 msg_len; /* valid values are 3...6 */
- };
-
- struct dvb_diseqc_slave_reply {
- __u8 msg [4]; /* { framing, data [3] } */
- __u8 msg_len; /* valid values are 0...4, 0 means no msg */
- int timeout; /* return from ioctl after timeout ms with */
- }; /* errorcode when no message was received */
-
- enum fe_sec_voltage {
- SEC_VOLTAGE_13,
- SEC_VOLTAGE_18,
- SEC_VOLTAGE_OFF
- };
-
- enum fe_sec_tone_mode {
- SEC_TONE_ON,
- SEC_TONE_OFF
- };
-
- enum fe_sec_mini_cmd {
- SEC_MINI_A,
- SEC_MINI_B
- };
-
- /**
- * enum fe_status - enumerates the possible frontend status
- * @FE_HAS_SIGNAL: found something above the noise level
- * @FE_HAS_CARRIER: found a DVB signal
- * @FE_HAS_VITERBI: FEC is stable
- * @FE_HAS_SYNC: found sync bytes
- * @FE_HAS_LOCK: everything's working
- * @FE_TIMEDOUT: no lock within the last ~2 seconds
- * @FE_REINIT: frontend was reinitialized, application is recommended
- * to reset DiSEqC, tone and parameters
- */
- enum fe_status {
- FE_HAS_SIGNAL = 0x01,
- FE_HAS_CARRIER = 0x02,
- FE_HAS_VITERBI = 0x04,
- FE_HAS_SYNC = 0x08,
- FE_HAS_LOCK = 0x10,
- FE_TIMEDOUT = 0x20,
- FE_REINIT = 0x40,
- };
-
- enum fe_spectral_inversion {
- INVERSION_OFF,
- INVERSION_ON,
- INVERSION_AUTO
- };
-
- enum fe_code_rate {
- FEC_NONE = 0,
- FEC_1_2,
- FEC_2_3,
- FEC_3_4,
- FEC_4_5,
- FEC_5_6,
- FEC_6_7,
- FEC_7_8,
- FEC_8_9,
- FEC_AUTO,
- FEC_3_5,
- FEC_9_10,
- FEC_2_5,
- };
-
- enum fe_modulation {
- QPSK,
- QAM_16,
- QAM_32,
- QAM_64,
- QAM_128,
- QAM_256,
- QAM_AUTO,
- VSB_8,
- VSB_16,
- PSK_8,
- APSK_16,
- APSK_32,
- DQPSK,
- QAM_4_NR,
- };
-
- enum fe_transmit_mode {
- TRANSMISSION_MODE_2K,
- TRANSMISSION_MODE_8K,
- TRANSMISSION_MODE_AUTO,
- TRANSMISSION_MODE_4K,
- TRANSMISSION_MODE_1K,
- TRANSMISSION_MODE_16K,
- TRANSMISSION_MODE_32K,
- TRANSMISSION_MODE_C1,
- TRANSMISSION_MODE_C3780,
- };
-
- enum fe_guard_interval {
- GUARD_INTERVAL_1_32,
- GUARD_INTERVAL_1_16,
- GUARD_INTERVAL_1_8,
- GUARD_INTERVAL_1_4,
- GUARD_INTERVAL_AUTO,
- GUARD_INTERVAL_1_128,
- GUARD_INTERVAL_19_128,
- GUARD_INTERVAL_19_256,
- GUARD_INTERVAL_PN420,
- GUARD_INTERVAL_PN595,
- GUARD_INTERVAL_PN945,
- };
-
- enum fe_hierarchy {
- HIERARCHY_NONE,
- HIERARCHY_1,
- HIERARCHY_2,
- HIERARCHY_4,
- HIERARCHY_AUTO
- };
-
- enum fe_interleaving {
- INTERLEAVING_NONE,
- INTERLEAVING_AUTO,
- INTERLEAVING_240,
- INTERLEAVING_720,
- };
-
- /* S2API Commands */
- #define DTV_UNDEFINED 0
- #define DTV_TUNE 1
- #define DTV_CLEAR 2
- #define DTV_FREQUENCY 3
- #define DTV_MODULATION 4
- #define DTV_BANDWIDTH_HZ 5
- #define DTV_INVERSION 6
- #define DTV_DISEQC_MASTER 7
- #define DTV_SYMBOL_RATE 8
- #define DTV_INNER_FEC 9
- #define DTV_VOLTAGE 10
- #define DTV_TONE 11
- #define DTV_PILOT 12
- #define DTV_ROLLOFF 13
- #define DTV_DISEQC_SLAVE_REPLY 14
-
- /* Basic enumeration set for querying unlimited capabilities */
- #define DTV_FE_CAPABILITY_COUNT 15
- #define DTV_FE_CAPABILITY 16
- #define DTV_DELIVERY_SYSTEM 17
-
- /* ISDB-T and ISDB-Tsb */
- #define DTV_ISDBT_PARTIAL_RECEPTION 18
- #define DTV_ISDBT_SOUND_BROADCASTING 19
-
- #define DTV_ISDBT_SB_SUBCHANNEL_ID 20
- #define DTV_ISDBT_SB_SEGMENT_IDX 21
- #define DTV_ISDBT_SB_SEGMENT_COUNT 22
-
- #define DTV_ISDBT_LAYERA_FEC 23
- #define DTV_ISDBT_LAYERA_MODULATION 24
- #define DTV_ISDBT_LAYERA_SEGMENT_COUNT 25
- #define DTV_ISDBT_LAYERA_TIME_INTERLEAVING 26
-
- #define DTV_ISDBT_LAYERB_FEC 27
- #define DTV_ISDBT_LAYERB_MODULATION 28
- #define DTV_ISDBT_LAYERB_SEGMENT_COUNT 29
- #define DTV_ISDBT_LAYERB_TIME_INTERLEAVING 30
-
- #define DTV_ISDBT_LAYERC_FEC 31
- #define DTV_ISDBT_LAYERC_MODULATION 32
- #define DTV_ISDBT_LAYERC_SEGMENT_COUNT 33
- #define DTV_ISDBT_LAYERC_TIME_INTERLEAVING 34
-
- #define DTV_API_VERSION 35
-
- #define DTV_CODE_RATE_HP 36
- #define DTV_CODE_RATE_LP 37
- #define DTV_GUARD_INTERVAL 38
- #define DTV_TRANSMISSION_MODE 39
- #define DTV_HIERARCHY 40
-
- #define DTV_ISDBT_LAYER_ENABLED 41
-
- #define DTV_STREAM_ID 42
- #define DTV_ISDBS_TS_ID_LEGACY DTV_STREAM_ID
- #define DTV_DVBT2_PLP_ID_LEGACY 43
-
- #define DTV_ENUM_DELSYS 44
-
- /* ATSC-MH */
- #define DTV_ATSCMH_FIC_VER 45
- #define DTV_ATSCMH_PARADE_ID 46
- #define DTV_ATSCMH_NOG 47
- #define DTV_ATSCMH_TNOG 48
- #define DTV_ATSCMH_SGN 49
- #define DTV_ATSCMH_PRC 50
- #define DTV_ATSCMH_RS_FRAME_MODE 51
- #define DTV_ATSCMH_RS_FRAME_ENSEMBLE 52
- #define DTV_ATSCMH_RS_CODE_MODE_PRI 53
- #define DTV_ATSCMH_RS_CODE_MODE_SEC 54
- #define DTV_ATSCMH_SCCC_BLOCK_MODE 55
- #define DTV_ATSCMH_SCCC_CODE_MODE_A 56
- #define DTV_ATSCMH_SCCC_CODE_MODE_B 57
- #define DTV_ATSCMH_SCCC_CODE_MODE_C 58
- #define DTV_ATSCMH_SCCC_CODE_MODE_D 59
-
- #define DTV_INTERLEAVING 60
- #define DTV_LNA 61
-
- /* Quality parameters */
- #define DTV_STAT_SIGNAL_STRENGTH 62
- #define DTV_STAT_CNR 63
- #define DTV_STAT_PRE_ERROR_BIT_COUNT 64
- #define DTV_STAT_PRE_TOTAL_BIT_COUNT 65
- #define DTV_STAT_POST_ERROR_BIT_COUNT 66
- #define DTV_STAT_POST_TOTAL_BIT_COUNT 67
- #define DTV_STAT_ERROR_BLOCK_COUNT 68
- #define DTV_STAT_TOTAL_BLOCK_COUNT 69
-
- #define DTV_MAX_COMMAND DTV_STAT_TOTAL_BLOCK_COUNT
-
- enum fe_pilot {
- PILOT_ON,
- PILOT_OFF,
- PILOT_AUTO,
- };
-
- enum fe_rolloff {
- ROLLOFF_35, /* Implied value in DVB-S, default for DVB-S2 */
- ROLLOFF_20,
- ROLLOFF_25,
- ROLLOFF_AUTO,
- };
-
- enum fe_delivery_system {
- SYS_UNDEFINED,
- SYS_DVBC_ANNEX_A,
- SYS_DVBC_ANNEX_B,
- SYS_DVBT,
- SYS_DSS,
- SYS_DVBS,
- SYS_DVBS2,
- SYS_DVBH,
- SYS_ISDBT,
- SYS_ISDBS,
- SYS_ISDBC,
- SYS_ATSC,
- SYS_ATSCMH,
- SYS_DTMB,
- SYS_CMMB,
- SYS_DAB,
- SYS_DVBT2,
- SYS_TURBO,
- SYS_DVBC_ANNEX_C,
- };
-
- /* backward compatibility */
- #define SYS_DVBC_ANNEX_AC SYS_DVBC_ANNEX_A
- #define SYS_DMBTH SYS_DTMB /* DMB-TH is legacy name, use DTMB instead */
-
- /* ATSC-MH */
-
- enum atscmh_sccc_block_mode {
- ATSCMH_SCCC_BLK_SEP = 0,
- ATSCMH_SCCC_BLK_COMB = 1,
- ATSCMH_SCCC_BLK_RES = 2,
- };
-
- enum atscmh_sccc_code_mode {
- ATSCMH_SCCC_CODE_HLF = 0,
- ATSCMH_SCCC_CODE_QTR = 1,
- ATSCMH_SCCC_CODE_RES = 2,
- };
-
- enum atscmh_rs_frame_ensemble {
- ATSCMH_RSFRAME_ENS_PRI = 0,
- ATSCMH_RSFRAME_ENS_SEC = 1,
- };
-
- enum atscmh_rs_frame_mode {
- ATSCMH_RSFRAME_PRI_ONLY = 0,
- ATSCMH_RSFRAME_PRI_SEC = 1,
- ATSCMH_RSFRAME_RES = 2,
- };
-
- enum atscmh_rs_code_mode {
- ATSCMH_RSCODE_211_187 = 0,
- ATSCMH_RSCODE_223_187 = 1,
- ATSCMH_RSCODE_235_187 = 2,
- ATSCMH_RSCODE_RES = 3,
- };
-
- #define NO_STREAM_ID_FILTER (~0U)
- #define LNA_AUTO (~0U)
-
- struct dtv_cmds_h {
- char *name; /* A display name for debugging purposes */
-
- __u32 cmd; /* A unique ID */
-
- /* Flags */
- __u32 set:1; /* Either a set or get property */
- __u32 buffer:1; /* Does this property use the buffer? */
- __u32 reserved:30; /* Align */
- };
-
- /**
- * Scale types for the quality parameters.
- * @FE_SCALE_NOT_AVAILABLE: That QoS measure is not available. That
- * could indicate a temporary or a permanent
- * condition.
- * @FE_SCALE_DECIBEL: The scale is measured in 0.001 dB steps, typically
- * used on signal measures.
- * @FE_SCALE_RELATIVE: The scale is a relative percentual measure,
- * ranging from 0 (0%) to 0xffff (100%).
- * @FE_SCALE_COUNTER: The scale counts the occurrence of an event, like
- * bit error, block error, lapsed time.
- */
- enum fecap_scale_params {
- FE_SCALE_NOT_AVAILABLE = 0,
- FE_SCALE_DECIBEL,
- FE_SCALE_RELATIVE,
- FE_SCALE_COUNTER
- };
-
- /**
- * struct dtv_stats - Used for reading a DTV status property
- *
- * @value: value of the measure. Should range from 0 to 0xffff;
- * @scale: Filled with enum fecap_scale_params - the scale
- * in usage for that parameter
- *
- * For most delivery systems, this will return a single value for each
- * parameter.
- * It should be noticed, however, that new OFDM delivery systems like
- * ISDB can use different modulation types for each group of carriers.
- * On such standards, up to 8 groups of statistics can be provided, one
- * for each carrier group (called "layer" on ISDB).
- * In order to be consistent with other delivery systems, the first
- * value refers to the entire set of carriers ("global").
- * dtv_status:scale should use the value FE_SCALE_NOT_AVAILABLE when
- * the value for the entire group of carriers or from one specific layer
- * is not provided by the hardware.
- * st.len should be filled with the latest filled status + 1.
- *
- * In other words, for ISDB, those values should be filled like:
- * u.st.stat.svalue[0] = global statistics;
- * u.st.stat.scale[0] = FE_SCALE_DECIBEL;
- * u.st.stat.value[1] = layer A statistics;
- * u.st.stat.scale[1] = FE_SCALE_NOT_AVAILABLE (if not available);
- * u.st.stat.svalue[2] = layer B statistics;
- * u.st.stat.scale[2] = FE_SCALE_DECIBEL;
- * u.st.stat.svalue[3] = layer C statistics;
- * u.st.stat.scale[3] = FE_SCALE_DECIBEL;
- * u.st.len = 4;
- */
- struct dtv_stats {
- __u8 scale; /* enum fecap_scale_params type */
- union {
- __u64 uvalue; /* for counters and relative scales */
- __s64 svalue; /* for 0.001 dB measures */
- };
- } __attribute__ ((packed));
-
-
- #define MAX_DTV_STATS 4
-
- struct dtv_fe_stats {
- __u8 len;
- struct dtv_stats stat[MAX_DTV_STATS];
- } __attribute__ ((packed));
-
- struct dtv_property {
- __u32 cmd;
- __u32 reserved[3];
- union {
- __u32 data;
- struct dtv_fe_stats st;
- struct {
- __u8 data[32];
- __u32 len;
- __u32 reserved1[3];
- void *reserved2;
- } buffer;
- } u;
- int result;
- } __attribute__ ((packed));
-
- /* num of properties cannot exceed DTV_IOCTL_MAX_MSGS per ioctl */
- #define DTV_IOCTL_MAX_MSGS 64
-
- struct dtv_properties {
- __u32 num;
- struct dtv_property *props;
- };
-
- #if defined(__DVB_CORE__) || !defined (__KERNEL__)
-
- /*
- * DEPRECATED: The DVBv3 ioctls, structs and enums should not be used on
- * newer programs, as it doesn't support the second generation of digital
- * TV standards, nor supports newer delivery systems.
- */
-
- enum fe_bandwidth {
- BANDWIDTH_8_MHZ,
- BANDWIDTH_7_MHZ,
- BANDWIDTH_6_MHZ,
- BANDWIDTH_AUTO,
- BANDWIDTH_5_MHZ,
- BANDWIDTH_10_MHZ,
- BANDWIDTH_1_712_MHZ,
- };
-
- /* This is needed for legacy userspace support */
- typedef enum fe_sec_voltage fe_sec_voltage_t;
- typedef enum fe_caps fe_caps_t;
- typedef enum fe_type fe_type_t;
- typedef enum fe_sec_tone_mode fe_sec_tone_mode_t;
- typedef enum fe_sec_mini_cmd fe_sec_mini_cmd_t;
- typedef enum fe_status fe_status_t;
- typedef enum fe_spectral_inversion fe_spectral_inversion_t;
- typedef enum fe_code_rate fe_code_rate_t;
- typedef enum fe_modulation fe_modulation_t;
- typedef enum fe_transmit_mode fe_transmit_mode_t;
- typedef enum fe_bandwidth fe_bandwidth_t;
- typedef enum fe_guard_interval fe_guard_interval_t;
- typedef enum fe_hierarchy fe_hierarchy_t;
- typedef enum fe_pilot fe_pilot_t;
- typedef enum fe_rolloff fe_rolloff_t;
- typedef enum fe_delivery_system fe_delivery_system_t;
-
- struct dvb_qpsk_parameters {
- __u32 symbol_rate; /* symbol rate in Symbols per second */
- fe_code_rate_t fec_inner; /* forward error correction (see above) */
- };
-
- struct dvb_qam_parameters {
- __u32 symbol_rate; /* symbol rate in Symbols per second */
- fe_code_rate_t fec_inner; /* forward error correction (see above) */
- fe_modulation_t modulation; /* modulation type (see above) */
- };
-
- struct dvb_vsb_parameters {
- fe_modulation_t modulation; /* modulation type (see above) */
- };
-
- struct dvb_ofdm_parameters {
- fe_bandwidth_t bandwidth;
- fe_code_rate_t code_rate_HP; /* high priority stream code rate */
- fe_code_rate_t code_rate_LP; /* low priority stream code rate */
- fe_modulation_t constellation; /* modulation type (see above) */
- fe_transmit_mode_t transmission_mode;
- fe_guard_interval_t guard_interval;
- fe_hierarchy_t hierarchy_information;
- };
-
- struct dvb_frontend_parameters {
- __u32 frequency; /* (absolute) frequency in Hz for DVB-C/DVB-T/ATSC */
- /* intermediate frequency in kHz for DVB-S */
- fe_spectral_inversion_t inversion;
- union {
- struct dvb_qpsk_parameters qpsk; /* DVB-S */
- struct dvb_qam_parameters qam; /* DVB-C */
- struct dvb_ofdm_parameters ofdm; /* DVB-T */
- struct dvb_vsb_parameters vsb; /* ATSC */
- } u;
- };
-
- struct dvb_frontend_event {
- fe_status_t status;
- struct dvb_frontend_parameters parameters;
- };
- #endif
-
- #define FE_SET_PROPERTY _IOW('o', 82, struct dtv_properties)
- #define FE_GET_PROPERTY _IOR('o', 83, struct dtv_properties)
-
- /**
- * When set, this flag will disable any zigzagging or other "normal" tuning
- * behaviour. Additionally, there will be no automatic monitoring of the lock
- * status, and hence no frontend events will be generated. If a frontend device
- * is closed, this flag will be automatically turned off when the device is
- * reopened read-write.
- */
- #define FE_TUNE_MODE_ONESHOT 0x01
-
- #define FE_GET_INFO _IOR('o', 61, struct dvb_frontend_info)
-
- #define FE_DISEQC_RESET_OVERLOAD _IO('o', 62)
- #define FE_DISEQC_SEND_MASTER_CMD _IOW('o', 63, struct dvb_diseqc_master_cmd)
- #define FE_DISEQC_RECV_SLAVE_REPLY _IOR('o', 64, struct dvb_diseqc_slave_reply)
- #define FE_DISEQC_SEND_BURST _IO('o', 65) /* fe_sec_mini_cmd_t */
-
- #define FE_SET_TONE _IO('o', 66) /* fe_sec_tone_mode_t */
- #define FE_SET_VOLTAGE _IO('o', 67) /* fe_sec_voltage_t */
- #define FE_ENABLE_HIGH_LNB_VOLTAGE _IO('o', 68) /* int */
-
- #define FE_READ_STATUS _IOR('o', 69, fe_status_t)
- #define FE_READ_BER _IOR('o', 70, __u32)
- #define FE_READ_SIGNAL_STRENGTH _IOR('o', 71, __u16)
- #define FE_READ_SNR _IOR('o', 72, __u16)
- #define FE_READ_UNCORRECTED_BLOCKS _IOR('o', 73, __u32)
-
- #define FE_SET_FRONTEND _IOW('o', 76, struct dvb_frontend_parameters)
- #define FE_GET_FRONTEND _IOR('o', 77, struct dvb_frontend_parameters)
- #define FE_SET_FRONTEND_TUNE_MODE _IO('o', 81) /* unsigned int */
- #define FE_GET_EVENT _IOR('o', 78, struct dvb_frontend_event)
-
- #define FE_DISHNETWORK_SEND_LEGACY_CMD _IO('o', 80) /* unsigned int */
-
- #endif /*_DVBFRONTEND_H_*/
diff --git a/Documentation/linux_tv/frontend.h.rst.exceptions b/Documentation/linux_tv/frontend.h.rst.exceptions
new file mode 100644
index 000000000000..60f2cbb92656
--- /dev/null
+++ b/Documentation/linux_tv/frontend.h.rst.exceptions
@@ -0,0 +1,47 @@
+# Ignore header name
+ignore define _DVBFRONTEND_H_
+
+# Group layer A-C symbols together
+replace define DTV_ISDBT_LAYERA_FEC dtv-isdbt-layer-fec
+replace define DTV_ISDBT_LAYERB_FEC dtv-isdbt-layer-fec
+replace define DTV_ISDBT_LAYERC_FEC dtv-isdbt-layer-fec
+replace define DTV_ISDBT_LAYERA_MODULATION dtv-isdbt-layer-modulation
+replace define DTV_ISDBT_LAYERB_MODULATION dtv-isdbt-layer-modulation
+replace define DTV_ISDBT_LAYERC_MODULATION dtv-isdbt-layer-modulation
+replace define DTV_ISDBT_LAYERA_SEGMENT_COUNT dtv-isdbt-layer-segment-count
+replace define DTV_ISDBT_LAYERB_SEGMENT_COUNT dtv-isdbt-layer-segment-count
+replace define DTV_ISDBT_LAYERC_SEGMENT_COUNT dtv-isdbt-layer-segment-count
+replace define DTV_ISDBT_LAYERA_TIME_INTERLEAVING dtv-isdbt-layer-time-interleaving
+replace define DTV_ISDBT_LAYERB_TIME_INTERLEAVING dtv-isdbt-layer-time-interleaving
+replace define DTV_ISDBT_LAYERC_TIME_INTERLEAVING dtv-isdbt-layer-time-interleaving
+
+# Ignore legacy defines
+ignore define DTV_ISDBS_TS_ID_LEGACY
+ignore define SYS_DVBC_ANNEX_AC
+ignore define SYS_DMBTH
+
+# Ignore limits
+ignore define DTV_MAX_COMMAND
+ignore define MAX_DTV_STATS
+ignore define DTV_IOCTL_MAX_MSGS
+
+# Stats enum is documented altogether
+replace enum fecap_scale_params frontend-stat-properties
+replace symbol FE_SCALE_COUNTER frontend-stat-properties
+replace symbol FE_SCALE_DECIBEL frontend-stat-properties
+replace symbol FE_SCALE_NOT_AVAILABLE frontend-stat-properties
+replace symbol FE_SCALE_RELATIVE frontend-stat-properties
+
+# the same reference is used for both get and set ioctls
+replace ioctl FE_SET_PROPERTY FE_GET_PROPERTY
+
+# Ignore struct used only internally at Kernel
+ignore struct dtv_cmds_h
+
+# Typedefs that use the enum reference
+replace typedef fe_sec_voltage_t fe-sec-voltage
+
+# Replaces for flag constants
+replace define FE_TUNE_MODE_ONESHOT fe_set_frontend_tune_mode
+replace define LNA_AUTO dtv-lna
+replace define NO_STREAM_ID_FILTER dtv-stream-id
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 31/54] doc-rst: parse-headers: improve delimiters to detect symbols
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (29 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 30/54] doc-rst: auto-build the frontend.h.rst Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 32/54] doc-dst: parse-headers: highlight deprecated comments Mauro Carvalho Chehab
` (23 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
As we had to escape the symbols for the ReST markup to not do
the wrong thing, the logic to discover start/end of strings
are not trivial. Improve the end delimiter detection, in order
to highlight more occurrences of the strings.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 27 ++++++++++++++-------------
1 file changed, 14 insertions(+), 13 deletions(-)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index 287f6459e13a..ec9537ef586f 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -200,78 +200,79 @@ $data =~ s,([\_\`\*\<\>\&\\\\:\/]),\\$1,g;
# Add references
#
-my $separators = "[\n \t\,\)\=\:\{\}\;]";
+my $start_delim = "[ \n\t\(\=\*\@]";
+my $end_delim = "(\\s|,|\\\\=|\\\\:|\\;|\\\)|\\}|\\{)";
foreach my $r (keys %ioctls) {
my $n = $ioctls{$r};
- my $s = ":ref:`$r <$n>`";
+ my $s = "\\ :ref:`$r <$n>`\\ ";
$r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
print "$r -> $s\n" if ($debug);
- $data =~ s/([\s])($r)($separators)/$1$s$3/g;
+ $data =~ s/($start_delim)($r)$end_delim/$1$s$3/g;
}
foreach my $r (keys %defines) {
my $n = $defines{$r};
- my $s = ":ref:`$r <$n>`";
+ my $s = "\\ :ref:`$r <$n>`\\ ";
$r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
print "$r -> $s\n" if ($debug);
- $data =~ s/([\s])($r)($separators)/$1$s$3/g;
+ $data =~ s/($start_delim)($r)$end_delim/$1$s$3/g;
}
foreach my $r (keys %enum_symbols) {
my $n = $enum_symbols{$r};
- my $s = ":ref:`$r <$n>`";
+ my $s = "\\ :ref:`$r <$n>`\\ ";
$r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
print "$r -> $s\n" if ($debug);
- $data =~ s/([\s])($r)($separators)/$1$s$3/g;
+ $data =~ s/($start_delim)($r)$end_delim/$1$s$3/g;
}
foreach my $r (keys %enums) {
my $n = $enums{$r};
- my $s = ":ref:`enum $r <$n>`";
+ my $s = "\\ :ref:`enum $r <$n>`\\ ";
$r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
print "$r -> $s\n" if ($debug);
- $data =~ s/enum\s+($r)($separators)/$s$2/g;
+ $data =~ s/enum\s+($r)$end_delim/$s$2/g;
}
foreach my $r (keys %structs) {
my $n = $structs{$r};
- my $s = ":ref:`struct $r <$n>`";
+ my $s = "\\ :ref:`struct $r <$n>`\\ ";
$r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
print "$r -> $s\n" if ($debug);
- $data =~ s/struct\s+($r)($separators)/$s$2/g;
+ $data =~ s/struct\s+($r)$end_delim/$s$2/g;
}
foreach my $r (keys %typedefs) {
my $n = $typedefs{$r};
- my $s = ":ref:`$r <$n>`";
+ my $s = "\\ :ref:`$r <$n>`\\ ";
$r =~ s,([\_\`\*\<\>\&\\\\:\/]),\\\\$1,g;
print "$r -> $s\n" if ($debug);
- $data =~ s/([\s\(\,\=])($r)($separators)/$1$s$3/g;
+ $data =~ s/($start_delim)($r)$end_delim/$1$s$3/g;
}
#
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 32/54] doc-dst: parse-headers: highlight deprecated comments
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (30 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 31/54] doc-rst: parse-headers: improve delimiters to detect symbols Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 33/54] doc-rst: fix parsing comments and '{' on a separate line Mauro Carvalho Chehab
` (22 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
When something is deprecated, highlight it, as we want it
to be clearer to the reader.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 2 ++
1 file changed, 2 insertions(+)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index ec9537ef586f..59f2c90f6942 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -196,6 +196,8 @@ $data =~ s/\n\s+\n/\n\n/g;
#
$data =~ s,([\_\`\*\<\>\&\\\\:\/]),\\$1,g;
+$data =~ s,DEPRECATED,**DEPRECATED**,g;
+
#
# Add references
#
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 33/54] doc-rst: fix parsing comments and '{' on a separate line
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (31 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 32/54] doc-dst: parse-headers: highlight deprecated comments Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 34/54] doc-rst: parse-headers: be more formal about the valid symbols Mauro Carvalho Chehab
` (21 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The dmx.h header has two things that causes the parser to
break while handling enums:
per-header enums and the '{' starts on a new line
Both makes the parser to get lexical marks to be detected
as if they were symbols.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 17 +++++++++++------
1 file changed, 11 insertions(+), 6 deletions(-)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index 59f2c90f6942..bf6f0df895f4 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -29,9 +29,12 @@ my %structs;
my $is_enum = 0;
open IN, $file_in or die "Can't open $file_in";
while (<IN>) {
+ my $ln = $_;
+ $ln =~ s,/\*.*\*/,,;
+
$data .= $_;
- if ($is_enum && m/^\s*([^\s\}\,\=]+)\s*[\,=]?/) {
+ if ($is_enum && $ln =~ m/^\s*([_A-Z][^\s\}\,\=]+)\s*[\,=]?/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -44,7 +47,7 @@ while (<IN>) {
}
$is_enum = 0 if ($is_enum && m/\}/);
- if (m/^\s*#\s*define\s+([_A-Z]\S+)\s+_IO/) {
+ if ($ln =~ m/^\s*#\s*define\s+([_A-Z]\S+)\s+_IO/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -53,7 +56,7 @@ while (<IN>) {
next;
}
- if (m/^\s*#\s*define\s+([_A-Z]\S+)\s+/) {
+ if ($ln =~ m/^\s*#\s*define\s+([_A-Z]\S+)\s+/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -63,7 +66,7 @@ while (<IN>) {
next;
}
- if (m/^\s*typedef\s+.*\s+([_\w]\S+);/) {
+ if ($ln =~ m/^\s*typedef\s+.*\s+([_\w]\S+);/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -72,7 +75,8 @@ while (<IN>) {
$typedefs{$s} = $n;
next;
}
- if (m/^\s*enum\s+(\S+)\s+\{/ || m/^\s*enum\s+(\S+)$/) {
+ if ($ln =~ m/^\s*enum\s+(\S+)\s+\{/
+ || $ln =~ m/^\s*enum\s+(\S+)$/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -83,7 +87,8 @@ while (<IN>) {
$is_enum = $1;
next;
}
- if (m/^\s*struct\s+([_A-Za-z_]\S+)\s+\{/ || m/^\s*struct\s+([A-Za-z_]\S+)$/) {
+ if ($ln =~ m/^\s*struct\s+([_A-Za-z_]\S+)\s+\{/
+ || $ln =~ m/^\s*struct\s+([A-Za-z_]\S+)$/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 34/54] doc-rst: parse-headers: be more formal about the valid symbols
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (32 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 33/54] doc-rst: fix parsing comments and '{' on a separate line Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 35/54] doc-rst: parse-headers: better handle typedefs Mauro Carvalho Chehab
` (20 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Be more formal about the valid symbols that are expected by
the parser, to match what c language expects.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index bf6f0df895f4..5e366756084f 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -34,7 +34,7 @@ while (<IN>) {
$data .= $_;
- if ($is_enum && $ln =~ m/^\s*([_A-Z][^\s\}\,\=]+)\s*[\,=]?/) {
+ if ($is_enum && $ln =~ m/^\s*([_\w][\w\d_]+)\s*[\,=]?/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -47,7 +47,7 @@ while (<IN>) {
}
$is_enum = 0 if ($is_enum && m/\}/);
- if ($ln =~ m/^\s*#\s*define\s+([_A-Z]\S+)\s+_IO/) {
+ if ($ln =~ m/^\s*#\s*define\s+([_\w][\w\d_]+)\s+_IO/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -56,7 +56,7 @@ while (<IN>) {
next;
}
- if ($ln =~ m/^\s*#\s*define\s+([_A-Z]\S+)\s+/) {
+ if ($ln =~ m/^\s*#\s*define\s+([_\w][\w\d_]+)\s+/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -66,7 +66,7 @@ while (<IN>) {
next;
}
- if ($ln =~ m/^\s*typedef\s+.*\s+([_\w]\S+);/) {
+ if ($ln =~ m/^\s*typedef\s+.*\s+([_\w][\w\d_]+);/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -75,8 +75,8 @@ while (<IN>) {
$typedefs{$s} = $n;
next;
}
- if ($ln =~ m/^\s*enum\s+(\S+)\s+\{/
- || $ln =~ m/^\s*enum\s+(\S+)$/) {
+ if ($ln =~ m/^\s*enum\s+([_\w][\w\d_]+)\s+\{/
+ || $ln =~ m/^\s*enum\s+([_\w][\w\d_]+)$/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -87,8 +87,8 @@ while (<IN>) {
$is_enum = $1;
next;
}
- if ($ln =~ m/^\s*struct\s+([_A-Za-z_]\S+)\s+\{/
- || $ln =~ m/^\s*struct\s+([A-Za-z_]\S+)$/) {
+ if ($ln =~ m/^\s*struct\s+([_\w][\w\d_]+)\s+\{/
+ || $ln =~ m/^\s*struct\s+([[_\w][\w\d_]+)$/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 35/54] doc-rst: parse-headers: better handle typedefs
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (33 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 34/54] doc-rst: parse-headers: be more formal about the valid symbols Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 36/54] doc-rst: parse-headers: fix multiline typedef handler Mauro Carvalho Chehab
` (19 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
When typedef is used on its multiline format, we need to
also parse enum and struct in the same line.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index 5e366756084f..b657cadb53ae 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -76,7 +76,9 @@ while (<IN>) {
next;
}
if ($ln =~ m/^\s*enum\s+([_\w][\w\d_]+)\s+\{/
- || $ln =~ m/^\s*enum\s+([_\w][\w\d_]+)$/) {
+ || $ln =~ m/^\s*enum\s+([_\w][\w\d_]+)$/
+ || $ln =~ m/^\s*typedef\s*enum\s+([_\w][\w\d_]+)\s+\{/
+ || $ln =~ m/^\s*typedef\s*enum\s+([_\w][\w\d_]+)$/) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
@@ -88,7 +90,10 @@ while (<IN>) {
next;
}
if ($ln =~ m/^\s*struct\s+([_\w][\w\d_]+)\s+\{/
- || $ln =~ m/^\s*struct\s+([[_\w][\w\d_]+)$/) {
+ || $ln =~ m/^\s*struct\s+([[_\w][\w\d_]+)$/
+ || $ln =~ m/^\s*typedef\s*struct\s+([_\w][\w\d_]+)\s+\{/
+ || $ln =~ m/^\s*typedef\s*struct\s+([[_\w][\w\d_]+)$/
+ ) {
my $s = $1;
my $n = $1;
$n =~ tr/A-Z/a-z/;
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 36/54] doc-rst: parse-headers: fix multiline typedef handler
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (34 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 35/54] doc-rst: parse-headers: better handle typedefs Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 37/54] doc-rst: auto-generate dmx.h.rst Mauro Carvalho Chehab
` (18 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The typedef handler should do two things to be generic:
1) parse typedef enums;
2) accept both possible syntaxes:
typedef struct foo { .. } foo_t;
typedef struct { .. } foo_t;
Unfortunately, this is needed to parse some legacy DVB
files, like dvb/audio.h.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index b657cadb53ae..b703f1a7f432 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -109,10 +109,11 @@ close IN;
# Handle multi-line typedefs
#
-my @matches = $data =~ m/typedef\s+struct\s+\S+\s*\{[^\}]+\}\s*(\S+)\s*\;/g;
+my @matches = ($data =~ m/typedef\s+struct\s+\S+?\s*\{[^\}]+\}\s*(\S+)\s*\;/g,
+ $data =~ m/typedef\s+enum\s+\S+?\s*\{[^\}]+\}\s*(\S+)\s*\;/g,);
foreach my $m (@matches) {
- my $s = $1;
- my $n = $1;
+ my $s = $m;
+ my $n = $m;
$n =~ tr/A-Z/a-z/;
$n =~ tr/_/-/;
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 37/54] doc-rst: auto-generate dmx.h.rst
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (35 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 36/54] doc-rst: parse-headers: fix multiline typedef handler Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 38/54] doc-rst: auto-generate audio.h.rst Mauro Carvalho Chehab
` (17 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This file should be auto-generated from the header files,
and not hardcoded.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/Makefile | 5 +-
Documentation/linux_tv/dmx.h.rst | 162 ----------------------------
Documentation/linux_tv/dmx.h.rst.exceptions | 63 +++++++++++
3 files changed, 67 insertions(+), 163 deletions(-)
delete mode 100644 Documentation/linux_tv/dmx.h.rst
create mode 100644 Documentation/linux_tv/dmx.h.rst.exceptions
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index d5570193ea30..2ef624e40bd9 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -3,10 +3,13 @@
PARSER = ../sphinx/parse-headers.pl
UAPI = ../../include/uapi/linux
-htmldocs: frontend.h.rst
+htmldocs: frontend.h.rst dmx.h.rst
frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h frontend.h.rst.exceptions
${PARSER} ${UAPI}/dvb/frontend.h $@ frontend.h.rst.exceptions
+dmx.h.rst: ${PARSER} ${UAPI}/dvb/dmx.h dmx.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/dmx.h $@ dmx.h.rst.exceptions
+
clean:
-rm frontend.h.rst
diff --git a/Documentation/linux_tv/dmx.h.rst b/Documentation/linux_tv/dmx.h.rst
deleted file mode 100644
index 05686c09aebc..000000000000
--- a/Documentation/linux_tv/dmx.h.rst
+++ /dev/null
@@ -1,162 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: dmx.h
-===========
-
-.. code-block:: c
-
- /*
- * dmx.h
- *
- * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de>
- * & Ralph Metzler <ralph@convergence.de>
- * for convergence integrated media GmbH
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
- #ifndef _UAPI_DVBDMX_H_
- #define _UAPI_DVBDMX_H_
-
- #include <linux/types.h>
- #ifndef __KERNEL__
- #include <time.h>
- #endif
-
-
- #define DMX_FILTER_SIZE 16
-
- enum dmx_output
- {
- DMX_OUT_DECODER, /* Streaming directly to decoder. */
- DMX_OUT_TAP, /* Output going to a memory buffer */
- /* (to be retrieved via the read command).*/
- DMX_OUT_TS_TAP, /* Output multiplexed into a new TS */
- /* (to be retrieved by reading from the */
- /* logical DVR device). */
- DMX_OUT_TSDEMUX_TAP /* Like TS_TAP but retrieved from the DMX device */
- };
-
- typedef enum dmx_output dmx_output_t;
-
- typedef enum dmx_input
- {
- DMX_IN_FRONTEND, /* Input from a front-end device. */
- DMX_IN_DVR /* Input from the logical DVR device. */
- } dmx_input_t;
-
-
- typedef enum dmx_ts_pes
- {
- DMX_PES_AUDIO0,
- DMX_PES_VIDEO0,
- DMX_PES_TELETEXT0,
- DMX_PES_SUBTITLE0,
- DMX_PES_PCR0,
-
- DMX_PES_AUDIO1,
- DMX_PES_VIDEO1,
- DMX_PES_TELETEXT1,
- DMX_PES_SUBTITLE1,
- DMX_PES_PCR1,
-
- DMX_PES_AUDIO2,
- DMX_PES_VIDEO2,
- DMX_PES_TELETEXT2,
- DMX_PES_SUBTITLE2,
- DMX_PES_PCR2,
-
- DMX_PES_AUDIO3,
- DMX_PES_VIDEO3,
- DMX_PES_TELETEXT3,
- DMX_PES_SUBTITLE3,
- DMX_PES_PCR3,
-
- DMX_PES_OTHER
- } dmx_pes_type_t;
-
- #define DMX_PES_AUDIO DMX_PES_AUDIO0
- #define DMX_PES_VIDEO DMX_PES_VIDEO0
- #define DMX_PES_TELETEXT DMX_PES_TELETEXT0
- #define DMX_PES_SUBTITLE DMX_PES_SUBTITLE0
- #define DMX_PES_PCR DMX_PES_PCR0
-
-
- typedef struct dmx_filter
- {
- __u8 filter[DMX_FILTER_SIZE];
- __u8 mask[DMX_FILTER_SIZE];
- __u8 mode[DMX_FILTER_SIZE];
- } dmx_filter_t;
-
-
- struct dmx_sct_filter_params
- {
- __u16 pid;
- dmx_filter_t filter;
- __u32 timeout;
- __u32 flags;
- #define DMX_CHECK_CRC 1
- #define DMX_ONESHOT 2
- #define DMX_IMMEDIATE_START 4
- #define DMX_KERNEL_CLIENT 0x8000
- };
-
-
- struct dmx_pes_filter_params
- {
- __u16 pid;
- dmx_input_t input;
- dmx_output_t output;
- dmx_pes_type_t pes_type;
- __u32 flags;
- };
-
- typedef struct dmx_caps {
- __u32 caps;
- int num_decoders;
- } dmx_caps_t;
-
- typedef enum dmx_source {
- DMX_SOURCE_FRONT0 = 0,
- DMX_SOURCE_FRONT1,
- DMX_SOURCE_FRONT2,
- DMX_SOURCE_FRONT3,
- DMX_SOURCE_DVR0 = 16,
- DMX_SOURCE_DVR1,
- DMX_SOURCE_DVR2,
- DMX_SOURCE_DVR3
- } dmx_source_t;
-
- struct dmx_stc {
- unsigned int num; /* input : which STC? 0..N */
- unsigned int base; /* output: divisor for stc to get 90 kHz clock */
- __u64 stc; /* output: stc in 'base'*90 kHz units */
- };
-
- #define DMX_START _IO('o', 41)
- #define DMX_STOP _IO('o', 42)
- #define DMX_SET_FILTER _IOW('o', 43, struct dmx_sct_filter_params)
- #define DMX_SET_PES_FILTER _IOW('o', 44, struct dmx_pes_filter_params)
- #define DMX_SET_BUFFER_SIZE _IO('o', 45)
- #define DMX_GET_PES_PIDS _IOR('o', 47, __u16[5])
- #define DMX_GET_CAPS _IOR('o', 48, dmx_caps_t)
- #define DMX_SET_SOURCE _IOW('o', 49, dmx_source_t)
- #define DMX_GET_STC _IOWR('o', 50, struct dmx_stc)
- #define DMX_ADD_PID _IOW('o', 51, __u16)
- #define DMX_REMOVE_PID _IOW('o', 52, __u16)
-
- #endif /* _UAPI_DVBDMX_H_ */
diff --git a/Documentation/linux_tv/dmx.h.rst.exceptions b/Documentation/linux_tv/dmx.h.rst.exceptions
new file mode 100644
index 000000000000..8200653839d2
--- /dev/null
+++ b/Documentation/linux_tv/dmx.h.rst.exceptions
@@ -0,0 +1,63 @@
+# Ignore header name
+ignore define _UAPI_DVBDMX_H_
+
+# Ignore limit constants
+ignore define DMX_FILTER_SIZE
+
+# dmx-pes-type-t enum symbols
+replace enum dmx_ts_pes dmx-pes-type-t
+replace symbol DMX_PES_AUDIO0 dmx-pes-type-t
+replace symbol DMX_PES_VIDEO0 dmx-pes-type-t
+replace symbol DMX_PES_TELETEXT0 dmx-pes-type-t
+replace symbol DMX_PES_SUBTITLE0 dmx-pes-type-t
+replace symbol DMX_PES_PCR0 dmx-pes-type-t
+replace symbol DMX_PES_AUDIO1 dmx-pes-type-t
+replace symbol DMX_PES_VIDEO1 dmx-pes-type-t
+replace symbol DMX_PES_TELETEXT1 dmx-pes-type-t
+replace symbol DMX_PES_SUBTITLE1 dmx-pes-type-t
+replace symbol DMX_PES_PCR1 dmx-pes-type-t
+replace symbol DMX_PES_AUDIO2 dmx-pes-type-t
+replace symbol DMX_PES_VIDEO2 dmx-pes-type-t
+replace symbol DMX_PES_TELETEXT2 dmx-pes-type-t
+replace symbol DMX_PES_SUBTITLE2 dmx-pes-type-t
+replace symbol DMX_PES_PCR2 dmx-pes-type-t
+replace symbol DMX_PES_AUDIO3 dmx-pes-type-t
+replace symbol DMX_PES_VIDEO3 dmx-pes-type-t
+replace symbol DMX_PES_TELETEXT3 dmx-pes-type-t
+replace symbol DMX_PES_SUBTITLE3 dmx-pes-type-t
+replace symbol DMX_PES_PCR3 dmx-pes-type-t
+replace symbol DMX_PES_OTHER dmx-pes-type-t
+
+# Ignore obsolete symbols
+ignore define DMX_PES_AUDIO
+ignore define DMX_PES_VIDEO
+ignore define DMX_PES_TELETEXT
+ignore define DMX_PES_SUBTITLE
+ignore define DMX_PES_PCR
+
+# dmx_input_t symbols
+replace enum dmx_input dmx-input-t
+replace symbol DMX_IN_FRONTEND dmx-input-t
+replace symbol DMX_IN_DVR dmx-input-t
+
+# dmx_source_t symbols
+replace enum dmx_source dmx-source-t
+replace symbol DMX_SOURCE_FRONT0 dmx-source-t
+replace symbol DMX_SOURCE_FRONT1 dmx-source-t
+replace symbol DMX_SOURCE_FRONT2 dmx-source-t
+replace symbol DMX_SOURCE_FRONT3 dmx-source-t
+replace symbol DMX_SOURCE_DVR0 dmx-source-t
+replace symbol DMX_SOURCE_DVR1 dmx-source-t
+replace symbol DMX_SOURCE_DVR2 dmx-source-t
+replace symbol DMX_SOURCE_DVR3 dmx-source-t
+
+
+# Flags for struct dmx_sct_filter_params
+replace define DMX_CHECK_CRC dmx-sct-filter-params
+replace define DMX_ONESHOT dmx-sct-filter-params
+replace define DMX_IMMEDIATE_START dmx-sct-filter-params
+replace define DMX_KERNEL_CLIENT dmx-sct-filter-params
+
+# some typedefs should point to struct/enums
+replace typedef dmx_caps_t dmx-caps
+replace typedef dmx_filter_t dmx-filter
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 38/54] doc-rst: auto-generate audio.h.rst
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (36 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 37/54] doc-rst: auto-generate dmx.h.rst Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 39/54] doc-rst: auto-generate ca.h.rst Mauro Carvalho Chehab
` (16 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This is an auto-generated header. Remove the hardcoded one
and do the right thing here.
NOTE: this is a deprecated API. So, we won't make any
effort to try identifying the meaning of this obscure
API that is used only on a legacy driver.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/Makefile | 9 +-
Documentation/linux_tv/audio.h.rst | 142 --------------------------
Documentation/linux_tv/audio.h.rst.exceptions | 20 ++++
3 files changed, 26 insertions(+), 145 deletions(-)
delete mode 100644 Documentation/linux_tv/audio.h.rst
create mode 100644 Documentation/linux_tv/audio.h.rst.exceptions
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 2ef624e40bd9..2eb958e91eab 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -3,13 +3,16 @@
PARSER = ../sphinx/parse-headers.pl
UAPI = ../../include/uapi/linux
-htmldocs: frontend.h.rst dmx.h.rst
+htmldocs: audio.h.rst dmx.h.rst frontend.h.rst
-frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h frontend.h.rst.exceptions
- ${PARSER} ${UAPI}/dvb/frontend.h $@ frontend.h.rst.exceptions
+audio.h.rst: ${PARSER} ${UAPI}/dvb/audio.h audio.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/audio.h $@ audio.h.rst.exceptions
dmx.h.rst: ${PARSER} ${UAPI}/dvb/dmx.h dmx.h.rst.exceptions
${PARSER} ${UAPI}/dvb/dmx.h $@ dmx.h.rst.exceptions
+frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h frontend.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/frontend.h $@ frontend.h.rst.exceptions
+
clean:
-rm frontend.h.rst
diff --git a/Documentation/linux_tv/audio.h.rst b/Documentation/linux_tv/audio.h.rst
deleted file mode 100644
index 42b7b41ec120..000000000000
--- a/Documentation/linux_tv/audio.h.rst
+++ /dev/null
@@ -1,142 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: audio.h
-=============
-
-.. code-block:: c
-
- /*
- * audio.h
- *
- * Copyright (C) 2000 Ralph Metzler <ralph@convergence.de>
- * & Marcus Metzler <marcus@convergence.de>
- * for convergence integrated media GmbH
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Lesser Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
- #ifndef _DVBAUDIO_H_
- #define _DVBAUDIO_H_
-
- #include <linux/types.h>
-
- typedef enum {
- AUDIO_SOURCE_DEMUX, /* Select the demux as the main source */
- AUDIO_SOURCE_MEMORY /* Select internal memory as the main source */
- } audio_stream_source_t;
-
-
- typedef enum {
- AUDIO_STOPPED, /* Device is stopped */
- AUDIO_PLAYING, /* Device is currently playing */
- AUDIO_PAUSED /* Device is paused */
- } audio_play_state_t;
-
-
- typedef enum {
- AUDIO_STEREO,
- AUDIO_MONO_LEFT,
- AUDIO_MONO_RIGHT,
- AUDIO_MONO,
- AUDIO_STEREO_SWAPPED
- } audio_channel_select_t;
-
-
- typedef struct audio_mixer {
- unsigned int volume_left;
- unsigned int volume_right;
- // what else do we need? bass, pass-through, ...
- } audio_mixer_t;
-
-
- typedef struct audio_status {
- int AV_sync_state; /* sync audio and video? */
- int mute_state; /* audio is muted */
- audio_play_state_t play_state; /* current playback state */
- audio_stream_source_t stream_source; /* current stream source */
- audio_channel_select_t channel_select; /* currently selected channel */
- int bypass_mode; /* pass on audio data to */
- audio_mixer_t mixer_state; /* current mixer state */
- } audio_status_t; /* separate decoder hardware */
-
-
- typedef
- struct audio_karaoke { /* if Vocal1 or Vocal2 are non-zero, they get mixed */
- int vocal1; /* into left and right t at 70% each */
- int vocal2; /* if both, Vocal1 and Vocal2 are non-zero, Vocal1 gets*/
- int melody; /* mixed into the left channel and */
- /* Vocal2 into the right channel at 100% each. */
- /* if Melody is non-zero, the melody channel gets mixed*/
- } audio_karaoke_t; /* into left and right */
-
-
- typedef __u16 audio_attributes_t;
- /* bits: descr. */
- /* 15-13 audio coding mode (0=ac3, 2=mpeg1, 3=mpeg2ext, 4=LPCM, 6=DTS, */
- /* 12 multichannel extension */
- /* 11-10 audio type (0=not spec, 1=language included) */
- /* 9- 8 audio application mode (0=not spec, 1=karaoke, 2=surround) */
- /* 7- 6 Quantization / DRC (mpeg audio: 1=DRC exists)(lpcm: 0=16bit, */
- /* 5- 4 Sample frequency fs (0=48kHz, 1=96kHz) */
- /* 2- 0 number of audio channels (n+1 channels) */
-
-
- /* for GET_CAPABILITIES and SET_FORMAT, the latter should only set one bit */
- #define AUDIO_CAP_DTS 1
- #define AUDIO_CAP_LPCM 2
- #define AUDIO_CAP_MP1 4
- #define AUDIO_CAP_MP2 8
- #define AUDIO_CAP_MP3 16
- #define AUDIO_CAP_AAC 32
- #define AUDIO_CAP_OGG 64
- #define AUDIO_CAP_SDDS 128
- #define AUDIO_CAP_AC3 256
-
- #define AUDIO_STOP _IO('o', 1)
- #define AUDIO_PLAY _IO('o', 2)
- #define AUDIO_PAUSE _IO('o', 3)
- #define AUDIO_CONTINUE _IO('o', 4)
- #define AUDIO_SELECT_SOURCE _IO('o', 5)
- #define AUDIO_SET_MUTE _IO('o', 6)
- #define AUDIO_SET_AV_SYNC _IO('o', 7)
- #define AUDIO_SET_BYPASS_MODE _IO('o', 8)
- #define AUDIO_CHANNEL_SELECT _IO('o', 9)
- #define AUDIO_GET_STATUS _IOR('o', 10, audio_status_t)
-
- #define AUDIO_GET_CAPABILITIES _IOR('o', 11, unsigned int)
- #define AUDIO_CLEAR_BUFFER _IO('o', 12)
- #define AUDIO_SET_ID _IO('o', 13)
- #define AUDIO_SET_MIXER _IOW('o', 14, audio_mixer_t)
- #define AUDIO_SET_STREAMTYPE _IO('o', 15)
- #define AUDIO_SET_EXT_ID _IO('o', 16)
- #define AUDIO_SET_ATTRIBUTES _IOW('o', 17, audio_attributes_t)
- #define AUDIO_SET_KARAOKE _IOW('o', 18, audio_karaoke_t)
-
- /**
- * AUDIO_GET_PTS
- *
- * Read the 33 bit presentation time stamp as defined
- * in ITU T-REC-H.222.0 / ISO/IEC 13818-1.
- *
- * The PTS should belong to the currently played
- * frame if possible, but may also be a value close to it
- * like the PTS of the last decoded frame or the last PTS
- * extracted by the PES parser.
- */
- #define AUDIO_GET_PTS _IOR('o', 19, __u64)
- #define AUDIO_BILINGUAL_CHANNEL_SELECT _IO('o', 20)
-
- #endif /* _DVBAUDIO_H_ */
diff --git a/Documentation/linux_tv/audio.h.rst.exceptions b/Documentation/linux_tv/audio.h.rst.exceptions
new file mode 100644
index 000000000000..8330edcd906d
--- /dev/null
+++ b/Documentation/linux_tv/audio.h.rst.exceptions
@@ -0,0 +1,20 @@
+# Ignore header name
+ignore define _DVBAUDIO_H_
+
+# Typedef pointing to structs
+replace typedef audio_karaoke_t audio-karaoke
+
+# Undocumented audio caps, as this is a deprecated API anyway
+ignore define AUDIO_CAP_DTS
+ignore define AUDIO_CAP_LPCM
+ignore define AUDIO_CAP_MP1
+ignore define AUDIO_CAP_MP2
+ignore define AUDIO_CAP_MP3
+ignore define AUDIO_CAP_AAC
+ignore define AUDIO_CAP_OGG
+ignore define AUDIO_CAP_SDDS
+ignore define AUDIO_CAP_AC3
+
+# some typedefs should point to struct/enums
+replace typedef audio_mixer_t audio-mixer
+replace typedef audio_status_t audio-status
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 39/54] doc-rst: auto-generate ca.h.rst
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (37 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 38/54] doc-rst: auto-generate audio.h.rst Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 40/54] doc-rst: auto-generate net.h.rst Mauro Carvalho Chehab
` (15 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This file comes from the uAPI definition header, and
should be auto-generated, to be in sync with Kernel changes.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/Makefile | 5 +-
Documentation/linux_tv/ca.h.rst | 97 ------------------------------
Documentation/linux_tv/ca.h.rst.exceptions | 24 ++++++++
3 files changed, 28 insertions(+), 98 deletions(-)
delete mode 100644 Documentation/linux_tv/ca.h.rst
create mode 100644 Documentation/linux_tv/ca.h.rst.exceptions
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 2eb958e91eab..7ee14195802f 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -3,11 +3,14 @@
PARSER = ../sphinx/parse-headers.pl
UAPI = ../../include/uapi/linux
-htmldocs: audio.h.rst dmx.h.rst frontend.h.rst
+htmldocs: audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst
audio.h.rst: ${PARSER} ${UAPI}/dvb/audio.h audio.h.rst.exceptions
${PARSER} ${UAPI}/dvb/audio.h $@ audio.h.rst.exceptions
+ca.h.rst: ${PARSER} ${UAPI}/dvb/ca.h ca.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/ca.h $@ ca.h.rst.exceptions
+
dmx.h.rst: ${PARSER} ${UAPI}/dvb/dmx.h dmx.h.rst.exceptions
${PARSER} ${UAPI}/dvb/dmx.h $@ dmx.h.rst.exceptions
diff --git a/Documentation/linux_tv/ca.h.rst b/Documentation/linux_tv/ca.h.rst
deleted file mode 100644
index e86e73510ffc..000000000000
--- a/Documentation/linux_tv/ca.h.rst
+++ /dev/null
@@ -1,97 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: ca.h
-==========
-
-.. code-block:: c
-
- /*
- * ca.h
- *
- * Copyright (C) 2000 Ralph Metzler <ralph@convergence.de>
- * & Marcus Metzler <marcus@convergence.de>
- * for convergence integrated media GmbH
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Lesser Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
- #ifndef _DVBCA_H_
- #define _DVBCA_H_
-
- /* slot interface types and info */
-
- typedef struct ca_slot_info {
- int num; /* slot number */
-
- int type; /* CA interface this slot supports */
- #define CA_CI 1 /* CI high level interface */
- #define CA_CI_LINK 2 /* CI link layer level interface */
- #define CA_CI_PHYS 4 /* CI physical layer level interface */
- #define CA_DESCR 8 /* built-in descrambler */
- #define CA_SC 128 /* simple smart card interface */
-
- unsigned int flags;
- #define CA_CI_MODULE_PRESENT 1 /* module (or card) inserted */
- #define CA_CI_MODULE_READY 2
- } ca_slot_info_t;
-
-
- /* descrambler types and info */
-
- typedef struct ca_descr_info {
- unsigned int num; /* number of available descramblers (keys) */
- unsigned int type; /* type of supported scrambling system */
- #define CA_ECD 1
- #define CA_NDS 2
- #define CA_DSS 4
- } ca_descr_info_t;
-
- typedef struct ca_caps {
- unsigned int slot_num; /* total number of CA card and module slots */
- unsigned int slot_type; /* OR of all supported types */
- unsigned int descr_num; /* total number of descrambler slots (keys) */
- unsigned int descr_type; /* OR of all supported types */
- } ca_caps_t;
-
- /* a message to/from a CI-CAM */
- typedef struct ca_msg {
- unsigned int index;
- unsigned int type;
- unsigned int length;
- unsigned char msg[256];
- } ca_msg_t;
-
- typedef struct ca_descr {
- unsigned int index;
- unsigned int parity; /* 0 == even, 1 == odd */
- unsigned char cw[8];
- } ca_descr_t;
-
- typedef struct ca_pid {
- unsigned int pid;
- int index; /* -1 == disable*/
- } ca_pid_t;
-
- #define CA_RESET _IO('o', 128)
- #define CA_GET_CAP _IOR('o', 129, ca_caps_t)
- #define CA_GET_SLOT_INFO _IOR('o', 130, ca_slot_info_t)
- #define CA_GET_DESCR_INFO _IOR('o', 131, ca_descr_info_t)
- #define CA_GET_MSG _IOR('o', 132, ca_msg_t)
- #define CA_SEND_MSG _IOW('o', 133, ca_msg_t)
- #define CA_SET_DESCR _IOW('o', 134, ca_descr_t)
- #define CA_SET_PID _IOW('o', 135, ca_pid_t)
-
- #endif
diff --git a/Documentation/linux_tv/ca.h.rst.exceptions b/Documentation/linux_tv/ca.h.rst.exceptions
new file mode 100644
index 000000000000..09c13be67527
--- /dev/null
+++ b/Documentation/linux_tv/ca.h.rst.exceptions
@@ -0,0 +1,24 @@
+# Ignore header name
+ignore define _DVBCA_H_
+
+# struct ca_slot_info defines
+replace define CA_CI ca-slot-info
+replace define CA_CI_LINK ca-slot-info
+replace define CA_CI_PHYS ca-slot-info
+replace define CA_DESCR ca-slot-info
+replace define CA_SC ca-slot-info
+replace define CA_CI_MODULE_PRESENT ca-slot-info
+replace define CA_CI_MODULE_READY ca-slot-info
+
+# struct ca_descr_info defines
+replace define CA_ECD ca-descr-info
+replace define CA_NDS ca-descr-info
+replace define CA_DSS ca-descr-info
+
+# some typedefs should point to struct/enums
+replace typedef ca_pid_t ca-pid
+replace typedef ca_slot_info_t ca-slot-info
+replace typedef ca_descr_info_t ca-descr-info
+replace typedef ca_caps_t ca-caps
+replace typedef ca_msg_t ca-msg
+replace typedef ca_descr_t ca-descr
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 40/54] doc-rst: auto-generate net.h.rst
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (38 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 39/54] doc-rst: auto-generate ca.h.rst Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 41/54] doc-rst: auto-generate video.h.rst Mauro Carvalho Chehab
` (14 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This file comes from the uAPI definition header, and
should be auto-generated, to be in sync with Kernel changes.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/Makefile | 10 +++--
Documentation/linux_tv/net.h.rst | 59 -----------------------------
Documentation/linux_tv/net.h.rst.exceptions | 11 ++++++
3 files changed, 18 insertions(+), 62 deletions(-)
delete mode 100644 Documentation/linux_tv/net.h.rst
create mode 100644 Documentation/linux_tv/net.h.rst.exceptions
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 7ee14195802f..4ec743449776 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -2,8 +2,9 @@
PARSER = ../sphinx/parse-headers.pl
UAPI = ../../include/uapi/linux
+TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst
-htmldocs: audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst
+htmldocs: ${TARGETS}
audio.h.rst: ${PARSER} ${UAPI}/dvb/audio.h audio.h.rst.exceptions
${PARSER} ${UAPI}/dvb/audio.h $@ audio.h.rst.exceptions
@@ -17,5 +18,8 @@ dmx.h.rst: ${PARSER} ${UAPI}/dvb/dmx.h dmx.h.rst.exceptions
frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h frontend.h.rst.exceptions
${PARSER} ${UAPI}/dvb/frontend.h $@ frontend.h.rst.exceptions
-clean:
- -rm frontend.h.rst
+net.h.rst: ${PARSER} ${UAPI}/dvb/net.h net.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/net.h $@ net.h.rst.exceptions
+
+cleandocs:
+ -rm ${TARGETS}
diff --git a/Documentation/linux_tv/net.h.rst b/Documentation/linux_tv/net.h.rst
deleted file mode 100644
index 9b0f705c634b..000000000000
--- a/Documentation/linux_tv/net.h.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: net.h
-===========
-
-.. code-block:: c
-
- /*
- * net.h
- *
- * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de>
- * & Ralph Metzler <ralph@convergence.de>
- * for convergence integrated media GmbH
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
- #ifndef _DVBNET_H_
- #define _DVBNET_H_
-
- #include <linux/types.h>
-
- struct dvb_net_if {
- __u16 pid;
- __u16 if_num;
- __u8 feedtype;
- #define DVB_NET_FEEDTYPE_MPE 0 /* multi protocol encapsulation */
- #define DVB_NET_FEEDTYPE_ULE 1 /* ultra lightweight encapsulation */
- };
-
-
- #define NET_ADD_IF _IOWR('o', 52, struct dvb_net_if)
- #define NET_REMOVE_IF _IO('o', 53)
- #define NET_GET_IF _IOWR('o', 54, struct dvb_net_if)
-
-
- /* binary compatibility cruft: */
- struct __dvb_net_if_old {
- __u16 pid;
- __u16 if_num;
- };
- #define __NET_ADD_IF_OLD _IOWR('o', 52, struct __dvb_net_if_old)
- #define __NET_GET_IF_OLD _IOWR('o', 54, struct __dvb_net_if_old)
-
-
- #endif /*_DVBNET_H_*/
diff --git a/Documentation/linux_tv/net.h.rst.exceptions b/Documentation/linux_tv/net.h.rst.exceptions
new file mode 100644
index 000000000000..30a267483aa9
--- /dev/null
+++ b/Documentation/linux_tv/net.h.rst.exceptions
@@ -0,0 +1,11 @@
+# Ignore header name
+ignore define _DVBNET_H_
+
+# Ignore old ioctls/structs
+ignore ioctl __NET_ADD_IF_OLD
+ignore ioctl __NET_GET_IF_OLD
+ignore struct __dvb_net_if_old
+
+# Macros used at struct dvb_net_if
+replace define DVB_NET_FEEDTYPE_MPE dvb-net-if
+replace define DVB_NET_FEEDTYPE_ULE dvb-net-if
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 41/54] doc-rst: auto-generate video.h.rst
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (39 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 40/54] doc-rst: auto-generate net.h.rst Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 42/54] doc-rst: parse-headers: better handle comments at the source code Mauro Carvalho Chehab
` (13 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This file comes from the uAPI definition header, and
should be auto-generated, to be in sync with Kernel changes.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/Makefile | 5 +-
Documentation/linux_tv/video.h.rst | 280 --------------------------
Documentation/linux_tv/video.h.rst.exceptions | 40 ++++
3 files changed, 44 insertions(+), 281 deletions(-)
delete mode 100644 Documentation/linux_tv/video.h.rst
create mode 100644 Documentation/linux_tv/video.h.rst.exceptions
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 4ec743449776..1773132008da 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -2,7 +2,7 @@
PARSER = ../sphinx/parse-headers.pl
UAPI = ../../include/uapi/linux
-TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst
+TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst
htmldocs: ${TARGETS}
@@ -21,5 +21,8 @@ frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h frontend.h.rst.exceptions
net.h.rst: ${PARSER} ${UAPI}/dvb/net.h net.h.rst.exceptions
${PARSER} ${UAPI}/dvb/net.h $@ net.h.rst.exceptions
+video.h.rst: ${PARSER} ${UAPI}/dvb/video.h video.h.rst.exceptions
+ ${PARSER} ${UAPI}/dvb/video.h $@ video.h.rst.exceptions
+
cleandocs:
-rm ${TARGETS}
diff --git a/Documentation/linux_tv/video.h.rst b/Documentation/linux_tv/video.h.rst
deleted file mode 100644
index fbbfb89167da..000000000000
--- a/Documentation/linux_tv/video.h.rst
+++ /dev/null
@@ -1,280 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: video.h
-=============
-
-.. code-block:: c
-
- /*
- * video.h
- *
- * Copyright (C) 2000 Marcus Metzler <marcus@convergence.de>
- * & Ralph Metzler <ralph@convergence.de>
- * for convergence integrated media GmbH
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2.1
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
- *
- */
-
- #ifndef _UAPI_DVBVIDEO_H_
- #define _UAPI_DVBVIDEO_H_
-
- #include <linux/types.h>
- #ifndef __KERNEL__
- #include <time.h>
- #endif
-
- typedef enum {
- VIDEO_FORMAT_4_3, /* Select 4:3 format */
- VIDEO_FORMAT_16_9, /* Select 16:9 format. */
- VIDEO_FORMAT_221_1 /* 2.21:1 */
- } video_format_t;
-
-
- typedef enum {
- VIDEO_SYSTEM_PAL,
- VIDEO_SYSTEM_NTSC,
- VIDEO_SYSTEM_PALN,
- VIDEO_SYSTEM_PALNc,
- VIDEO_SYSTEM_PALM,
- VIDEO_SYSTEM_NTSC60,
- VIDEO_SYSTEM_PAL60,
- VIDEO_SYSTEM_PALM60
- } video_system_t;
-
-
- typedef enum {
- VIDEO_PAN_SCAN, /* use pan and scan format */
- VIDEO_LETTER_BOX, /* use letterbox format */
- VIDEO_CENTER_CUT_OUT /* use center cut out format */
- } video_displayformat_t;
-
- typedef struct {
- int w;
- int h;
- video_format_t aspect_ratio;
- } video_size_t;
-
- typedef enum {
- VIDEO_SOURCE_DEMUX, /* Select the demux as the main source */
- VIDEO_SOURCE_MEMORY /* If this source is selected, the stream
- comes from the user through the write
- system call */
- } video_stream_source_t;
-
-
- typedef enum {
- VIDEO_STOPPED, /* Video is stopped */
- VIDEO_PLAYING, /* Video is currently playing */
- VIDEO_FREEZED /* Video is freezed */
- } video_play_state_t;
-
-
- /* Decoder commands */
- #define VIDEO_CMD_PLAY (0)
- #define VIDEO_CMD_STOP (1)
- #define VIDEO_CMD_FREEZE (2)
- #define VIDEO_CMD_CONTINUE (3)
-
- /* Flags for VIDEO_CMD_FREEZE */
- #define VIDEO_CMD_FREEZE_TO_BLACK (1 << 0)
-
- /* Flags for VIDEO_CMD_STOP */
- #define VIDEO_CMD_STOP_TO_BLACK (1 << 0)
- #define VIDEO_CMD_STOP_IMMEDIATELY (1 << 1)
-
- /* Play input formats: */
- /* The decoder has no special format requirements */
- #define VIDEO_PLAY_FMT_NONE (0)
- /* The decoder requires full GOPs */
- #define VIDEO_PLAY_FMT_GOP (1)
-
- /* The structure must be zeroed before use by the application
- This ensures it can be extended safely in the future. */
- struct video_command {
- __u32 cmd;
- __u32 flags;
- union {
- struct {
- __u64 pts;
- } stop;
-
- struct {
- /* 0 or 1000 specifies normal speed,
- 1 specifies forward single stepping,
- -1 specifies backward single stepping,
- >1: playback at speed/1000 of the normal speed,
- <-1: reverse playback at (-speed/1000) of the normal speed. */
- __s32 speed;
- __u32 format;
- } play;
-
- struct {
- __u32 data[16];
- } raw;
- };
- };
-
- /* FIELD_UNKNOWN can be used if the hardware does not know whether
- the Vsync is for an odd, even or progressive (i.e.ie; non-interlaced)
- field. */
- #define VIDEO_VSYNC_FIELD_UNKNOWN (0)
- #define VIDEO_VSYNC_FIELD_ODD (1)
- #define VIDEO_VSYNC_FIELD_EVEN (2)
- #define VIDEO_VSYNC_FIELD_PROGRESSIVE (3)
-
- struct video_event {
- __s32 type;
- #define VIDEO_EVENT_SIZE_CHANGED 1
- #define VIDEO_EVENT_FRAME_RATE_CHANGED 2
- #define VIDEO_EVENT_DECODER_STOPPED 3
- #define VIDEO_EVENT_VSYNC 4
- __kernel_time_t timestamp;
- union {
- video_size_t size;
- unsigned int frame_rate; /* in frames per 1000sec */
- unsigned char vsync_field; /* unknown/odd/even/progressive */
- } u;
- };
-
-
- struct video_status {
- int video_blank; /* blank video on freeze? */
- video_play_state_t play_state; /* current state of playback */
- video_stream_source_t stream_source; /* current source (demux/memory) */
- video_format_t video_format; /* current aspect ratio of stream*/
- video_displayformat_t display_format;/* selected cropping mode */
- };
-
-
- struct video_still_picture {
- char __user *iFrame; /* pointer to a single iframe in memory */
- __s32 size;
- };
-
-
- typedef
- struct video_highlight {
- int active; /* 1=show highlight, 0=hide highlight */
- __u8 contrast1; /* 7- 4 Pattern pixel contrast */
- /* 3- 0 Background pixel contrast */
- __u8 contrast2; /* 7- 4 Emphasis pixel-2 contrast */
- /* 3- 0 Emphasis pixel-1 contrast */
- __u8 color1; /* 7- 4 Pattern pixel color */
- /* 3- 0 Background pixel color */
- __u8 color2; /* 7- 4 Emphasis pixel-2 color */
- /* 3- 0 Emphasis pixel-1 color */
- __u32 ypos; /* 23-22 auto action mode */
- /* 21-12 start y */
- /* 9- 0 end y */
- __u32 xpos; /* 23-22 button color number */
- /* 21-12 start x */
- /* 9- 0 end x */
- } video_highlight_t;
-
-
- typedef struct video_spu {
- int active;
- int stream_id;
- } video_spu_t;
-
-
- typedef struct video_spu_palette { /* SPU Palette information */
- int length;
- __u8 __user *palette;
- } video_spu_palette_t;
-
-
- typedef struct video_navi_pack {
- int length; /* 0 ... 1024 */
- __u8 data[1024];
- } video_navi_pack_t;
-
-
- typedef __u16 video_attributes_t;
- /* bits: descr. */
- /* 15-14 Video compression mode (0=MPEG-1, 1=MPEG-2) */
- /* 13-12 TV system (0=525/60, 1=625/50) */
- /* 11-10 Aspect ratio (0=4:3, 3=16:9) */
- /* 9- 8 permitted display mode on 4:3 monitor (0=both, 1=only pan-sca */
- /* 7 line 21-1 data present in GOP (1=yes, 0=no) */
- /* 6 line 21-2 data present in GOP (1=yes, 0=no) */
- /* 5- 3 source resolution (0=720x480/576, 1=704x480/576, 2=352x480/57 */
- /* 2 source letterboxed (1=yes, 0=no) */
- /* 0 film/camera mode (0=camera, 1=film (625/50 only)) */
-
-
- /* bit definitions for capabilities: */
- /* can the hardware decode MPEG1 and/or MPEG2? */
- #define VIDEO_CAP_MPEG1 1
- #define VIDEO_CAP_MPEG2 2
- /* can you send a system and/or program stream to video device?
- (you still have to open the video and the audio device but only
- send the stream to the video device) */
- #define VIDEO_CAP_SYS 4
- #define VIDEO_CAP_PROG 8
- /* can the driver also handle SPU, NAVI and CSS encoded data?
- (CSS API is not present yet) */
- #define VIDEO_CAP_SPU 16
- #define VIDEO_CAP_NAVI 32
- #define VIDEO_CAP_CSS 64
-
-
- #define VIDEO_STOP _IO('o', 21)
- #define VIDEO_PLAY _IO('o', 22)
- #define VIDEO_FREEZE _IO('o', 23)
- #define VIDEO_CONTINUE _IO('o', 24)
- #define VIDEO_SELECT_SOURCE _IO('o', 25)
- #define VIDEO_SET_BLANK _IO('o', 26)
- #define VIDEO_GET_STATUS _IOR('o', 27, struct video_status)
- #define VIDEO_GET_EVENT _IOR('o', 28, struct video_event)
- #define VIDEO_SET_DISPLAY_FORMAT _IO('o', 29)
- #define VIDEO_STILLPICTURE _IOW('o', 30, struct video_still_picture)
- #define VIDEO_FAST_FORWARD _IO('o', 31)
- #define VIDEO_SLOWMOTION _IO('o', 32)
- #define VIDEO_GET_CAPABILITIES _IOR('o', 33, unsigned int)
- #define VIDEO_CLEAR_BUFFER _IO('o', 34)
- #define VIDEO_SET_ID _IO('o', 35)
- #define VIDEO_SET_STREAMTYPE _IO('o', 36)
- #define VIDEO_SET_FORMAT _IO('o', 37)
- #define VIDEO_SET_SYSTEM _IO('o', 38)
- #define VIDEO_SET_HIGHLIGHT _IOW('o', 39, video_highlight_t)
- #define VIDEO_SET_SPU _IOW('o', 50, video_spu_t)
- #define VIDEO_SET_SPU_PALETTE _IOW('o', 51, video_spu_palette_t)
- #define VIDEO_GET_NAVI _IOR('o', 52, video_navi_pack_t)
- #define VIDEO_SET_ATTRIBUTES _IO('o', 53)
- #define VIDEO_GET_SIZE _IOR('o', 55, video_size_t)
- #define VIDEO_GET_FRAME_RATE _IOR('o', 56, unsigned int)
-
- /**
- * VIDEO_GET_PTS
- *
- * Read the 33 bit presentation time stamp as defined
- * in ITU T-REC-H.222.0 / ISO/IEC 13818-1.
- *
- * The PTS should belong to the currently played
- * frame if possible, but may also be a value close to it
- * like the PTS of the last decoded frame or the last PTS
- * extracted by the PES parser.
- */
- #define VIDEO_GET_PTS _IOR('o', 57, __u64)
-
- /* Read the number of displayed frames since the decoder was started */
- #define VIDEO_GET_FRAME_COUNT _IOR('o', 58, __u64)
-
- #define VIDEO_COMMAND _IOWR('o', 59, struct video_command)
- #define VIDEO_TRY_COMMAND _IOWR('o', 60, struct video_command)
-
- #endif /* _UAPI_DVBVIDEO_H_ */
diff --git a/Documentation/linux_tv/video.h.rst.exceptions b/Documentation/linux_tv/video.h.rst.exceptions
new file mode 100644
index 000000000000..8866145e8269
--- /dev/null
+++ b/Documentation/linux_tv/video.h.rst.exceptions
@@ -0,0 +1,40 @@
+# Ignore header name
+ignore define _UAPI_DVBVIDEO_H_
+
+# This is a deprecated obscure API. Just ignore things we don't know
+ignore define VIDEO_CMD_PLAY
+ignore define VIDEO_CMD_STOP
+ignore define VIDEO_CMD_FREEZE
+ignore define VIDEO_CMD_CONTINUE
+ignore define VIDEO_CMD_FREEZE_TO_BLACK
+ignore define VIDEO_CMD_STOP_TO_BLACK
+ignore define VIDEO_CMD_STOP_IMMEDIATELY
+ignore define VIDEO_PLAY_FMT_NONE
+ignore define VIDEO_PLAY_FMT_GOP
+ignore define VIDEO_VSYNC_FIELD_UNKNOWN
+ignore define VIDEO_VSYNC_FIELD_ODD
+ignore define VIDEO_VSYNC_FIELD_EVEN
+ignore define VIDEO_VSYNC_FIELD_PROGRESSIVE
+ignore define VIDEO_EVENT_SIZE_CHANGED
+ignore define VIDEO_EVENT_FRAME_RATE_CHANGED
+ignore define VIDEO_EVENT_DECODER_STOPPED
+ignore define VIDEO_EVENT_VSYNC
+ignore define VIDEO_CAP_MPEG1
+ignore define VIDEO_CAP_MPEG2
+ignore define VIDEO_CAP_SYS
+ignore define VIDEO_CAP_PROG
+ignore define VIDEO_CAP_SPU
+ignore define VIDEO_CAP_NAVI
+ignore define VIDEO_CAP_CSS
+
+# some typedefs should point to struct/enums
+replace typedef video_format_t video-format
+replace typedef video_system_t video-system
+replace typedef video_displayformat_t video-displayformat
+replace typedef video_size_t video-size
+replace typedef video_stream_source_t video-stream-source
+replace typedef video_play_state_t video-play-state
+replace typedef video_highlight_t video-highlight
+replace typedef video_spu_t video-spu
+replace typedef video_spu_palette_t video-spu-palette
+replace typedef video_navi_pack_t video-navi-pack
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 42/54] doc-rst: parse-headers: better handle comments at the source code
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (40 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 41/54] doc-rst: auto-generate video.h.rst Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 43/54] doc-rst: parse-headers: add an option to ignore enum symbols Mauro Carvalho Chehab
` (12 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
We should not let comments to mangle with the symbols
parsing. Unfortunately, videodev2.h has lots of those
in the middle of enums and structs. So, we need to improve
our parser to discard them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 17 ++++++++++++++---
1 file changed, 14 insertions(+), 3 deletions(-)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index b703f1a7f432..fc18eac1552c 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -27,13 +27,24 @@ my %structs;
#
my $is_enum = 0;
+my $is_comment = 0;
open IN, $file_in or die "Can't open $file_in";
while (<IN>) {
- my $ln = $_;
- $ln =~ s,/\*.*\*/,,;
-
$data .= $_;
+ my $ln = $_;
+ if (!$is_comment) {
+ $ln =~ s,/\*.*(\*/),,g;
+
+ $is_comment = 1 if ($ln =~ s,/\*.*,,);
+ } else {
+ if ($ln =~ s,^(.*\*/),,) {
+ $is_comment = 0;
+ } else {
+ next;
+ }
+ }
+
if ($is_enum && $ln =~ m/^\s*([_\w][\w\d_]+)\s*[\,=]?/) {
my $s = $1;
my $n = $1;
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 43/54] doc-rst: parse-headers: add an option to ignore enum symbols
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (41 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 42/54] doc-rst: parse-headers: better handle comments at the source code Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 44/54] doc-rst: parse-headers: don't do substituition references Mauro Carvalho Chehab
` (11 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
At videodev2.h, we have hundreds of symbols that don't
currently have a reference yet. Let's ignore for how, while
we don't improve those cross-refs.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 4 ++++
1 file changed, 4 insertions(+)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index fc18eac1552c..16ea28b0d2e1 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -163,6 +163,10 @@ if ($file_exceptions) {
delete $structs{$1} if (exists($structs{$1}));
next;
}
+ if (m/^ignore\s+symbol\s+(\S+)/) {
+ delete $enum_symbols{$1} if (exists($enum_symbols{$1}));
+ next;
+ }
# Parsers to replace a symbol
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 44/54] doc-rst: parse-headers: don't do substituition references
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (42 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 43/54] doc-rst: parse-headers: add an option to ignore enum symbols Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 45/54] doc-rst: autogenerate videodev2.h.rst file Mauro Carvalho Chehab
` (10 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Add one extra escape character to avoid those warnings:
Documentation/linux_tv/videodev2.h.rst:6: WARNING: Inline substitution_reference start-string without end-string.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
| 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
--git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl
index 16ea28b0d2e1..0a3703bef5eb 100755
--- a/Documentation/sphinx/parse-headers.pl
+++ b/Documentation/sphinx/parse-headers.pl
@@ -220,7 +220,7 @@ $data =~ s/\n\s+\n/\n\n/g;
#
# Add escape codes for special characters
#
-$data =~ s,([\_\`\*\<\>\&\\\\:\/]),\\$1,g;
+$data =~ s,([\_\`\*\<\>\&\\\\:\/\|]),\\$1,g;
$data =~ s,DEPRECATED,**DEPRECATED**,g;
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 45/54] doc-rst: autogenerate videodev2.h.rst file
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (43 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 44/54] doc-rst: parse-headers: don't do substituition references Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 46/54] doc-rst: fix some badly converted references Mauro Carvalho Chehab
` (9 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
This file comes from the uAPI definitions for V4L2, with is dynamic
and updated on almost every Kernel version. So, this file
needs to be auto-updated, as otherwise the documentation will
become obsolete too early.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/Makefile | 6 +-
Documentation/linux_tv/media/v4l/audio.rst | 8 +-
Documentation/linux_tv/media/v4l/hist-v4l2.rst | 4 +-
.../linux_tv/media/v4l/vidioc-enumaudioout.rst | 4 +-
.../linux_tv/media/v4l/vidioc-g-audioout.rst | 2 +-
Documentation/linux_tv/videodev2.h.rst | 2300 --------------------
Documentation/linux_tv/videodev2.h.rst.exceptions | 591 +++++
7 files changed, 605 insertions(+), 2310 deletions(-)
delete mode 100644 Documentation/linux_tv/videodev2.h.rst
create mode 100644 Documentation/linux_tv/videodev2.h.rst.exceptions
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 1773132008da..068e26e0cc6f 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -2,7 +2,8 @@
PARSER = ../sphinx/parse-headers.pl
UAPI = ../../include/uapi/linux
-TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst
+TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
+ videodev2.h.rst
htmldocs: ${TARGETS}
@@ -24,5 +25,8 @@ net.h.rst: ${PARSER} ${UAPI}/dvb/net.h net.h.rst.exceptions
video.h.rst: ${PARSER} ${UAPI}/dvb/video.h video.h.rst.exceptions
${PARSER} ${UAPI}/dvb/video.h $@ video.h.rst.exceptions
+videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} videodev2.h.rst.exceptions
+ ${PARSER} ${UAPI}/videodev2.h $@ videodev2.h.rst.exceptions
+
cleandocs:
-rm ${TARGETS}
diff --git a/Documentation/linux_tv/media/v4l/audio.rst b/Documentation/linux_tv/media/v4l/audio.rst
index b6c41c35a744..71502f0bf8bd 100644
--- a/Documentation/linux_tv/media/v4l/audio.rst
+++ b/Documentation/linux_tv/media/v4l/audio.rst
@@ -28,23 +28,23 @@ number, starting at zero, of one audio input or output.
To learn about the number and attributes of the available inputs and
outputs applications can enumerate them with the
:ref:`VIDIOC_ENUMAUDIO` and
-:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` ioctl, respectively.
+:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>` ioctl, respectively.
The struct :ref:`v4l2_audio <v4l2-audio>` returned by the
:ref:`VIDIOC_ENUMAUDIO` ioctl also contains signal
:status information applicable when the current audio input is queried.
The :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and
-:ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` ioctls report the current
+:ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDOUT>` ioctls report the current
audio input and output, respectively. Note that, unlike
:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and
:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` these ioctls return a
structure as :ref:`VIDIOC_ENUMAUDIO` and
-:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` do, not just an index.
+:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>` do, not just an index.
To select an audio input and change its properties applications call the
:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl. To select an audio
output (which presently has no changeable properties) applications call
-the :ref:`VIDIOC_S_AUDOUT <VIDIOC_G_AUDIOout>` ioctl.
+the :ref:`VIDIOC_S_AUDOUT <VIDIOC_G_AUDOUT>` ioctl.
Drivers must implement all audio input ioctls when the device has
multiple selectable audio inputs, all audio output ioctls when the
diff --git a/Documentation/linux_tv/media/v4l/hist-v4l2.rst b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
index 7dac98c5dc95..a571e099fde7 100644
--- a/Documentation/linux_tv/media/v4l/hist-v4l2.rst
+++ b/Documentation/linux_tv/media/v4l/hist-v4l2.rst
@@ -727,8 +727,8 @@ V4L2 2003-06-19
audio input.
The same changes were made to
- :ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` and
- :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>`.
+ :ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDOUT>` and
+ :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>`.
Until further the "videodev" module will automatically translate
between the old and new ioctls, but drivers and applications must be
diff --git a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
index 4c1756319c09..15bc5a40f4a6 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _VIDIOC_ENUMAUDIOOUT:
+.. _VIDIOC_ENUMAUDOUT:
***********************
ioctl VIDIOC_ENUMAUDOUT
@@ -44,7 +44,7 @@ zero, incrementing by one until the driver returns ``EINVAL``.
Note connectors on a TV card to loop back the received audio signal to a
sound card are not audio outputs in this sense.
-See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDIOout>` for a description of struct
+See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDOUT>` for a description of struct
:ref:`v4l2_audioout <v4l2-audioout>`.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
index e36b5a116332..bee5f78ed7c1 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _VIDIOC_G_AUDIOOUT:
+.. _VIDIOC_G_AUDOUT:
**************************************
ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
diff --git a/Documentation/linux_tv/videodev2.h.rst b/Documentation/linux_tv/videodev2.h.rst
deleted file mode 100644
index f3c9e6959be0..000000000000
--- a/Documentation/linux_tv/videodev2.h.rst
+++ /dev/null
@@ -1,2300 +0,0 @@
-.. -*- coding: utf-8; mode: rst -*-
-
-file: videodev2.h
-=================
-
-.. code-block:: c
-
- /*
- * Video for Linux Two header file
- *
- * Copyright (C) 1999-2012 the contributors
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * Alternatively you can redistribute this file under the terms of the
- * BSD license as stated below:
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- * 3. The names of its contributors may not be used to endorse or promote
- * products derived from this software without specific prior written
- * permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * Header file for v4l or V4L2 drivers and applications
- * with public API.
- * All kernel-specific stuff were moved to media/v4l2-dev.h, so
- * no #if __KERNEL tests are allowed here
- *
- * See https://linuxtv.org for more info
- *
- * Author: Bill Dirks <bill@thedirks.org>
- * Justin Schoeman
- * Hans Verkuil <hverkuil@xs4all.nl>
- * et al.
- */
- #ifndef _UAPI__LINUX_VIDEODEV2_H
- #define _UAPI__LINUX_VIDEODEV2_H
-
- #ifndef __KERNEL__
- #include <sys/time.h>
- #endif
- #include <linux/compiler.h>
- #include <linux/ioctl.h>
- #include <linux/types.h>
- #include <linux/v4l2-common.h>
- #include <linux/v4l2-controls.h>
-
- /*
- * Common stuff for both V4L1 and V4L2
- * Moved from videodev.h
- */
- #define VIDEO_MAX_FRAME 32
- #define VIDEO_MAX_PLANES 8
-
- /*
- * M I S C E L L A N E O U S
- */
-
- /* Four-character-code (FOURCC) */
- #define v4l2_fourcc(a, b, c, d)
- ((__u32)(a) | ((__u32)(b) << 8) | ((__u32)(c) << 16) | ((__u32)(d) << 24))
- #define v4l2_fourcc_be(a, b, c, d) (v4l2_fourcc(a, b, c, d) | (1 << 31))
-
- /*
- * E N U M S
- */
- enum v4l2_field {
- V4L2_FIELD_ANY = 0, /* driver can choose from none,
- top, bottom, interlaced
- depending on whatever it thinks
- is approximate ... */
- V4L2_FIELD_NONE = 1, /* this device has no fields ... */
- V4L2_FIELD_TOP = 2, /* top field only */
- V4L2_FIELD_BOTTOM = 3, /* bottom field only */
- V4L2_FIELD_INTERLACED = 4, /* both fields interlaced */
- V4L2_FIELD_SEQ_TB = 5, /* both fields sequential into one
- buffer, top-bottom order */
- V4L2_FIELD_SEQ_BT = 6, /* same as above + bottom-top order */
- V4L2_FIELD_ALTERNATE = 7, /* both fields alternating into
- separate buffers */
- V4L2_FIELD_INTERLACED_TB = 8, /* both fields interlaced, top field
- first and the top field is
- transmitted first */
- V4L2_FIELD_INTERLACED_BT = 9, /* both fields interlaced, top field
- first and the bottom field is
- transmitted first */
- };
- #define V4L2_FIELD_HAS_TOP(field)
- ((field) == V4L2_FIELD_TOP ||
- (field) == V4L2_FIELD_INTERLACED ||
- (field) == V4L2_FIELD_INTERLACED_TB ||
- (field) == V4L2_FIELD_INTERLACED_BT ||
- (field) == V4L2_FIELD_SEQ_TB ||
- (field) == V4L2_FIELD_SEQ_BT)
- #define V4L2_FIELD_HAS_BOTTOM(field)
- ((field) == V4L2_FIELD_BOTTOM ||
- (field) == V4L2_FIELD_INTERLACED ||
- (field) == V4L2_FIELD_INTERLACED_TB ||
- (field) == V4L2_FIELD_INTERLACED_BT ||
- (field) == V4L2_FIELD_SEQ_TB ||
- (field) == V4L2_FIELD_SEQ_BT)
- #define V4L2_FIELD_HAS_BOTH(field)
- ((field) == V4L2_FIELD_INTERLACED ||
- (field) == V4L2_FIELD_INTERLACED_TB ||
- (field) == V4L2_FIELD_INTERLACED_BT ||
- (field) == V4L2_FIELD_SEQ_TB ||
- (field) == V4L2_FIELD_SEQ_BT)
- #define V4L2_FIELD_HAS_T_OR_B(field)
- ((field) == V4L2_FIELD_BOTTOM ||
- (field) == V4L2_FIELD_TOP ||
- (field) == V4L2_FIELD_ALTERNATE)
-
- enum v4l2_buf_type {
- V4L2_BUF_TYPE_VIDEO_CAPTURE = 1,
- V4L2_BUF_TYPE_VIDEO_OUTPUT = 2,
- V4L2_BUF_TYPE_VIDEO_OVERLAY = 3,
- V4L2_BUF_TYPE_VBI_CAPTURE = 4,
- V4L2_BUF_TYPE_VBI_OUTPUT = 5,
- V4L2_BUF_TYPE_SLICED_VBI_CAPTURE = 6,
- V4L2_BUF_TYPE_SLICED_VBI_OUTPUT = 7,
- V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY = 8,
- V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE = 9,
- V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE = 10,
- V4L2_BUF_TYPE_SDR_CAPTURE = 11,
- V4L2_BUF_TYPE_SDR_OUTPUT = 12,
- /* Deprecated, do not use */
- V4L2_BUF_TYPE_PRIVATE = 0x80,
- };
-
- #define V4L2_TYPE_IS_MULTIPLANAR(type)
- ((type) == V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE
- || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE)
-
- #define V4L2_TYPE_IS_OUTPUT(type)
- ((type) == V4L2_BUF_TYPE_VIDEO_OUTPUT
- || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE
- || (type) == V4L2_BUF_TYPE_VIDEO_OVERLAY
- || (type) == V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY
- || (type) == V4L2_BUF_TYPE_VBI_OUTPUT
- || (type) == V4L2_BUF_TYPE_SLICED_VBI_OUTPUT
- || (type) == V4L2_BUF_TYPE_SDR_OUTPUT)
-
- enum v4l2_tuner_type {
- V4L2_TUNER_RADIO = 1,
- V4L2_TUNER_ANALOG_TV = 2,
- V4L2_TUNER_DIGITAL_TV = 3,
- V4L2_TUNER_SDR = 4,
- V4L2_TUNER_RF = 5,
- };
-
- /* Deprecated, do not use */
- #define V4L2_TUNER_ADC V4L2_TUNER_SDR
-
- enum v4l2_memory {
- V4L2_MEMORY_MMAP = 1,
- V4L2_MEMORY_USERPTR = 2,
- V4L2_MEMORY_OVERLAY = 3,
- V4L2_MEMORY_DMABUF = 4,
- };
-
- /* see also http://vektor.theorem.ca/graphics/ycbcr/ */
- enum v4l2_colorspace {
- /*
- * Default colorspace, i.e.ie; let the driver figure it out.
- * Can only be used with video capture.
- */
- V4L2_COLORSPACE_DEFAULT = 0,
-
- /* SMPTE 170M: used for broadcast NTSC/PAL SDTV */
- V4L2_COLORSPACE_SMPTE170M = 1,
-
- /* Obsolete pre-1998 SMPTE 240M HDTV standard, superseded by Rec 709 */
- V4L2_COLORSPACE_SMPTE240M = 2,
-
- /* Rec.709: used for HDTV */
- V4L2_COLORSPACE_REC709 = 3,
-
- /*
- * Deprecated, do not use. No driver will ever return this. This was
- * based on a misunderstanding of the bt878 datasheet.
- */
- V4L2_COLORSPACE_BT878 = 4,
-
- /*
- * NTSC 1953 colorspace. This only makes sense when dealing with
- * really, really old NTSC recordings. Superseded by SMPTE 170M.
- */
- V4L2_COLORSPACE_470_SYSTEM_M = 5,
-
- /*
- * EBU Tech 3213 PAL/SECAM colorspace. This only makes sense when
- * dealing with really old PAL/SECAM recordings. Superseded by
- * SMPTE 170M.
- */
- V4L2_COLORSPACE_470_SYSTEM_BG = 6,
-
- /*
- * Effectively shorthand for V4L2_COLORSPACE_SRGB, V4L2_YCBCR_ENC_601
- * and V4L2_QUANTIZATION_FULL_RANGE. To be used for (Motion-)JPEG.
- */
- V4L2_COLORSPACE_JPEG = 7,
-
- /* For RGB colorspaces such as produces by most webcams. */
- V4L2_COLORSPACE_SRGB = 8,
-
- /* AdobeRGB colorspace */
- V4L2_COLORSPACE_ADOBERGB = 9,
-
- /* BT.2020 colorspace, used for UHDTV. */
- V4L2_COLORSPACE_BT2020 = 10,
-
- /* Raw colorspace: for RAW unprocessed images */
- V4L2_COLORSPACE_RAW = 11,
-
- /* DCI-P3 colorspace, used by cinema projectors */
- V4L2_COLORSPACE_DCI_P3 = 12,
- };
-
- /*
- * Determine how COLORSPACE_DEFAULT should map to a proper colorspace.
- * This depends on whether this is a SDTV image (use SMPTE 170M), an
- * HDTV image (use Rec. 709), or something else (use sRGB).
- */
- #define V4L2_MAP_COLORSPACE_DEFAULT(is_sdtv, is_hdtv)
- ((is_sdtv) ? V4L2_COLORSPACE_SMPTE170M :
- ((is_hdtv) ? V4L2_COLORSPACE_REC709 : V4L2_COLORSPACE_SRGB))
-
- enum v4l2_xfer_func {
- /*
- * Mapping of V4L2_XFER_FUNC_DEFAULT to actual transfer functions
- * for the various colorspaces:
- *
- * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
- * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_REC709 and
- * V4L2_COLORSPACE_BT2020: V4L2_XFER_FUNC_709
- *
- * V4L2_COLORSPACE_SRGB, V4L2_COLORSPACE_JPEG: V4L2_XFER_FUNC_SRGB
- *
- * V4L2_COLORSPACE_ADOBERGB: V4L2_XFER_FUNC_ADOBERGB
- *
- * V4L2_COLORSPACE_SMPTE240M: V4L2_XFER_FUNC_SMPTE240M
- *
- * V4L2_COLORSPACE_RAW: V4L2_XFER_FUNC_NONE
- *
- * V4L2_COLORSPACE_DCI_P3: V4L2_XFER_FUNC_DCI_P3
- */
- V4L2_XFER_FUNC_DEFAULT = 0,
- V4L2_XFER_FUNC_709 = 1,
- V4L2_XFER_FUNC_SRGB = 2,
- V4L2_XFER_FUNC_ADOBERGB = 3,
- V4L2_XFER_FUNC_SMPTE240M = 4,
- V4L2_XFER_FUNC_NONE = 5,
- V4L2_XFER_FUNC_DCI_P3 = 6,
- V4L2_XFER_FUNC_SMPTE2084 = 7,
- };
-
- /*
- * Determine how XFER_FUNC_DEFAULT should map to a proper transfer function.
- * This depends on the colorspace.
- */
- #define V4L2_MAP_XFER_FUNC_DEFAULT(colsp)
- ((colsp) == V4L2_COLORSPACE_ADOBERGB ? V4L2_XFER_FUNC_ADOBERGB :
- ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_XFER_FUNC_SMPTE240M :
- ((colsp) == V4L2_COLORSPACE_DCI_P3 ? V4L2_XFER_FUNC_DCI_P3 :
- ((colsp) == V4L2_COLORSPACE_RAW ? V4L2_XFER_FUNC_NONE :
- ((colsp) == V4L2_COLORSPACE_SRGB || (colsp) == V4L2_COLORSPACE_JPEG ?
- V4L2_XFER_FUNC_SRGB : V4L2_XFER_FUNC_709)))))
-
- enum v4l2_ycbcr_encoding {
- /*
- * Mapping of V4L2_YCBCR_ENC_DEFAULT to actual encodings for the
- * various colorspaces:
- *
- * V4L2_COLORSPACE_SMPTE170M, V4L2_COLORSPACE_470_SYSTEM_M,
- * V4L2_COLORSPACE_470_SYSTEM_BG, V4L2_COLORSPACE_ADOBERGB and
- * V4L2_COLORSPACE_JPEG: V4L2_YCBCR_ENC_601
- *
- * V4L2_COLORSPACE_REC709 and V4L2_COLORSPACE_DCI_P3: V4L2_YCBCR_ENC_709
- *
- * V4L2_COLORSPACE_SRGB: V4L2_YCBCR_ENC_SYCC
- *
- * V4L2_COLORSPACE_BT2020: V4L2_YCBCR_ENC_BT2020
- *
- * V4L2_COLORSPACE_SMPTE240M: V4L2_YCBCR_ENC_SMPTE240M
- */
- V4L2_YCBCR_ENC_DEFAULT = 0,
-
- /* ITU-R 601 -- SDTV */
- V4L2_YCBCR_ENC_601 = 1,
-
- /* Rec. 709 -- HDTV */
- V4L2_YCBCR_ENC_709 = 2,
-
- /* ITU-R 601/EN 61966-2-4 Extended Gamut -- SDTV */
- V4L2_YCBCR_ENC_XV601 = 3,
-
- /* Rec. 709/EN 61966-2-4 Extended Gamut -- HDTV */
- V4L2_YCBCR_ENC_XV709 = 4,
-
- /* sYCC (Y'CbCr encoding of sRGB) */
- V4L2_YCBCR_ENC_SYCC = 5,
-
- /* BT.2020 Non-constant Luminance Y'CbCr */
- V4L2_YCBCR_ENC_BT2020 = 6,
-
- /* BT.2020 Constant Luminance Y'CbcCrc */
- V4L2_YCBCR_ENC_BT2020_CONST_LUM = 7,
-
- /* SMPTE 240M -- Obsolete HDTV */
- V4L2_YCBCR_ENC_SMPTE240M = 8,
- };
-
- /*
- * Determine how YCBCR_ENC_DEFAULT should map to a proper Y'CbCr encoding.
- * This depends on the colorspace.
- */
- #define V4L2_MAP_YCBCR_ENC_DEFAULT(colsp)
- (((colsp) == V4L2_COLORSPACE_REC709 ||
- (colsp) == V4L2_COLORSPACE_DCI_P3) ? V4L2_YCBCR_ENC_709 :
- ((colsp) == V4L2_COLORSPACE_BT2020 ? V4L2_YCBCR_ENC_BT2020 :
- ((colsp) == V4L2_COLORSPACE_SMPTE240M ? V4L2_YCBCR_ENC_SMPTE240M :
- V4L2_YCBCR_ENC_601)))
-
- enum v4l2_quantization {
- /*
- * The default for R'G'B' quantization is always full range, except
- * for the BT2020 colorspace. For Y'CbCr the quantization is always
- * limited range, except for COLORSPACE_JPEG, SYCC, XV601 or XV709:
- * those are full range.
- */
- V4L2_QUANTIZATION_DEFAULT = 0,
- V4L2_QUANTIZATION_FULL_RANGE = 1,
- V4L2_QUANTIZATION_LIM_RANGE = 2,
- };
-
- /*
- * Determine how QUANTIZATION_DEFAULT should map to a proper quantization.
- * This depends on whether the image is RGB or not, the colorspace and the
- * Y'CbCr encoding.
- */
- #define V4L2_MAP_QUANTIZATION_DEFAULT(is_rgb, colsp, ycbcr_enc)
- (((is_rgb) && (colsp) == V4L2_COLORSPACE_BT2020) ? V4L2_QUANTIZATION_LIM_RANGE :
- (((is_rgb) || (ycbcr_enc) == V4L2_YCBCR_ENC_XV601 ||
- (ycbcr_enc) == V4L2_YCBCR_ENC_XV709 || (colsp) == V4L2_COLORSPACE_JPEG) ?
- V4L2_QUANTIZATION_FULL_RANGE : V4L2_QUANTIZATION_LIM_RANGE))
-
- enum v4l2_priority {
- V4L2_PRIORITY_UNSET = 0, /* not initialized */
- V4L2_PRIORITY_BACKGROUND = 1,
- V4L2_PRIORITY_INTERACTIVE = 2,
- V4L2_PRIORITY_RECORD = 3,
- V4L2_PRIORITY_DEFAULT = V4L2_PRIORITY_INTERACTIVE,
- };
-
- struct v4l2_rect {
- __s32 left;
- __s32 top;
- __u32 width;
- __u32 height;
- };
-
- struct v4l2_fract {
- __u32 numerator;
- __u32 denominator;
- };
-
- /**
- * struct v4l2_capability - Describes V4L2 device caps returned by VIDIOC_QUERYCAP
- *
- * @driver: name of the driver module (e.g. "bttv")
- * @card: name of the card (e.g. "Hauppauge WinTV")
- * @bus_info: name of the bus (e.g. "PCI:" + pci_name(pci_dev) )
- * @version: KERNEL_VERSION
- * @capabilities: capabilities of the physical device as a whole
- * @device_caps: capabilities accessed via this particular device (node)
- * @reserved: reserved fields for future extensions
- */
- struct v4l2_capability {
- __u8 driver[16];
- __u8 card[32];
- __u8 bus_info[32];
- __u32 version;
- __u32 capabilities;
- __u32 device_caps;
- __u32 reserved[3];
- };
-
- /* Values for 'capabilities' field */
- #define V4L2_CAP_VIDEO_CAPTURE 0x00000001 /* Is a video capture device */
- #define V4L2_CAP_VIDEO_OUTPUT 0x00000002 /* Is a video output device */
- #define V4L2_CAP_VIDEO_OVERLAY 0x00000004 /* Can do video overlay */
- #define V4L2_CAP_VBI_CAPTURE 0x00000010 /* Is a raw VBI capture device */
- #define V4L2_CAP_VBI_OUTPUT 0x00000020 /* Is a raw VBI output device */
- #define V4L2_CAP_SLICED_VBI_CAPTURE 0x00000040 /* Is a sliced VBI capture device */
- #define V4L2_CAP_SLICED_VBI_OUTPUT 0x00000080 /* Is a sliced VBI output device */
- #define V4L2_CAP_RDS_CAPTURE 0x00000100 /* RDS data capture */
- #define V4L2_CAP_VIDEO_OUTPUT_OVERLAY 0x00000200 /* Can do video output overlay */
- #define V4L2_CAP_HW_FREQ_SEEK 0x00000400 /* Can do hardware frequency seek */
- #define V4L2_CAP_RDS_OUTPUT 0x00000800 /* Is an RDS encoder */
-
- /* Is a video capture device that supports multiplanar formats */
- #define V4L2_CAP_VIDEO_CAPTURE_MPLANE 0x00001000
- /* Is a video output device that supports multiplanar formats */
- #define V4L2_CAP_VIDEO_OUTPUT_MPLANE 0x00002000
- /* Is a video mem-to-mem device that supports multiplanar formats */
- #define V4L2_CAP_VIDEO_M2M_MPLANE 0x00004000
- /* Is a video mem-to-mem device */
- #define V4L2_CAP_VIDEO_M2M 0x00008000
-
- #define V4L2_CAP_TUNER 0x00010000 /* has a tuner */
- #define V4L2_CAP_AUDIO 0x00020000 /* has audio support */
- #define V4L2_CAP_RADIO 0x00040000 /* is a radio device */
- #define V4L2_CAP_MODULATOR 0x00080000 /* has a modulator */
-
- #define V4L2_CAP_SDR_CAPTURE 0x00100000 /* Is a SDR capture device */
- #define V4L2_CAP_EXT_PIX_FORMAT 0x00200000 /* Supports the extended pixel format */
- #define V4L2_CAP_SDR_OUTPUT 0x00400000 /* Is a SDR output device */
-
- #define V4L2_CAP_READWRITE 0x01000000 /* read/write systemcalls */
- #define V4L2_CAP_ASYNCIO 0x02000000 /* async I/O */
- #define V4L2_CAP_STREAMING 0x04000000 /* streaming I/O ioctls */
-
- #define V4L2_CAP_DEVICE_CAPS 0x80000000 /* sets device capabilities field */
-
- /*
- * V I D E O I M A G E F O R M A T
- */
- struct v4l2_pix_format {
- __u32 width;
- __u32 height;
- __u32 pixelformat;
- __u32 field; /* enum v4l2_field */
- __u32 bytesperline; /* for padding, zero if unused */
- __u32 sizeimage;
- __u32 colorspace; /* enum v4l2_colorspace */
- __u32 priv; /* private data, depends on pixelformat */
- __u32 flags; /* format flags (V4L2_PIX_FMT_FLAG_*) */
- __u32 ycbcr_enc; /* enum v4l2_ycbcr_encoding */
- __u32 quantization; /* enum v4l2_quantization */
- __u32 xfer_func; /* enum v4l2_xfer_func */
- };
-
- /* Pixel format FOURCC depth Description */
-
- /* RGB formats */
- #define V4L2_PIX_FMT_RGB332 v4l2_fourcc('R', 'G', 'B', '1') /* 8 RGB-3-3-2 */
- #define V4L2_PIX_FMT_RGB444 v4l2_fourcc('R', '4', '4', '4') /* 16 xxxxrrrr ggggbbbb */
- #define V4L2_PIX_FMT_ARGB444 v4l2_fourcc('A', 'R', '1', '2') /* 16 aaaarrrr ggggbbbb */
- #define V4L2_PIX_FMT_XRGB444 v4l2_fourcc('X', 'R', '1', '2') /* 16 xxxxrrrr ggggbbbb */
- #define V4L2_PIX_FMT_RGB555 v4l2_fourcc('R', 'G', 'B', 'O') /* 16 RGB-5-5-5 */
- #define V4L2_PIX_FMT_ARGB555 v4l2_fourcc('A', 'R', '1', '5') /* 16 ARGB-1-5-5-5 */
- #define V4L2_PIX_FMT_XRGB555 v4l2_fourcc('X', 'R', '1', '5') /* 16 XRGB-1-5-5-5 */
- #define V4L2_PIX_FMT_RGB565 v4l2_fourcc('R', 'G', 'B', 'P') /* 16 RGB-5-6-5 */
- #define V4L2_PIX_FMT_RGB555X v4l2_fourcc('R', 'G', 'B', 'Q') /* 16 RGB-5-5-5 BE */
- #define V4L2_PIX_FMT_ARGB555X v4l2_fourcc_be('A', 'R', '1', '5') /* 16 ARGB-5-5-5 BE */
- #define V4L2_PIX_FMT_XRGB555X v4l2_fourcc_be('X', 'R', '1', '5') /* 16 XRGB-5-5-5 BE */
- #define V4L2_PIX_FMT_RGB565X v4l2_fourcc('R', 'G', 'B', 'R') /* 16 RGB-5-6-5 BE */
- #define V4L2_PIX_FMT_BGR666 v4l2_fourcc('B', 'G', 'R', 'H') /* 18 BGR-6-6-6 */
- #define V4L2_PIX_FMT_BGR24 v4l2_fourcc('B', 'G', 'R', '3') /* 24 BGR-8-8-8 */
- #define V4L2_PIX_FMT_RGB24 v4l2_fourcc('R', 'G', 'B', '3') /* 24 RGB-8-8-8 */
- #define V4L2_PIX_FMT_BGR32 v4l2_fourcc('B', 'G', 'R', '4') /* 32 BGR-8-8-8-8 */
- #define V4L2_PIX_FMT_ABGR32 v4l2_fourcc('A', 'R', '2', '4') /* 32 BGRA-8-8-8-8 */
- #define V4L2_PIX_FMT_XBGR32 v4l2_fourcc('X', 'R', '2', '4') /* 32 BGRX-8-8-8-8 */
- #define V4L2_PIX_FMT_RGB32 v4l2_fourcc('R', 'G', 'B', '4') /* 32 RGB-8-8-8-8 */
- #define V4L2_PIX_FMT_ARGB32 v4l2_fourcc('B', 'A', '2', '4') /* 32 ARGB-8-8-8-8 */
- #define V4L2_PIX_FMT_XRGB32 v4l2_fourcc('B', 'X', '2', '4') /* 32 XRGB-8-8-8-8 */
-
- /* Grey formats */
- #define V4L2_PIX_FMT_GREY v4l2_fourcc('G', 'R', 'E', 'Y') /* 8 Greyscale */
- #define V4L2_PIX_FMT_Y4 v4l2_fourcc('Y', '0', '4', ' ') /* 4 Greyscale */
- #define V4L2_PIX_FMT_Y6 v4l2_fourcc('Y', '0', '6', ' ') /* 6 Greyscale */
- #define V4L2_PIX_FMT_Y10 v4l2_fourcc('Y', '1', '0', ' ') /* 10 Greyscale */
- #define V4L2_PIX_FMT_Y12 v4l2_fourcc('Y', '1', '2', ' ') /* 12 Greyscale */
- #define V4L2_PIX_FMT_Y16 v4l2_fourcc('Y', '1', '6', ' ') /* 16 Greyscale */
- #define V4L2_PIX_FMT_Y16_BE v4l2_fourcc_be('Y', '1', '6', ' ') /* 16 Greyscale BE */
-
- /* Grey bit-packed formats */
- #define V4L2_PIX_FMT_Y10BPACK v4l2_fourcc('Y', '1', '0', 'B') /* 10 Greyscale bit-packed */
-
- /* Palette formats */
- #define V4L2_PIX_FMT_PAL8 v4l2_fourcc('P', 'A', 'L', '8') /* 8 8-bit palette */
-
- /* Chrominance formats */
- #define V4L2_PIX_FMT_UV8 v4l2_fourcc('U', 'V', '8', ' ') /* 8 UV 4:4 */
-
- /* Luminance+Chrominance formats */
- #define V4L2_PIX_FMT_YVU410 v4l2_fourcc('Y', 'V', 'U', '9') /* 9 YVU 4:1:0 */
- #define V4L2_PIX_FMT_YVU420 v4l2_fourcc('Y', 'V', '1', '2') /* 12 YVU 4:2:0 */
- #define V4L2_PIX_FMT_YUYV v4l2_fourcc('Y', 'U', 'Y', 'V') /* 16 YUV 4:2:2 */
- #define V4L2_PIX_FMT_YYUV v4l2_fourcc('Y', 'Y', 'U', 'V') /* 16 YUV 4:2:2 */
- #define V4L2_PIX_FMT_YVYU v4l2_fourcc('Y', 'V', 'Y', 'U') /* 16 YVU 4:2:2 */
- #define V4L2_PIX_FMT_UYVY v4l2_fourcc('U', 'Y', 'V', 'Y') /* 16 YUV 4:2:2 */
- #define V4L2_PIX_FMT_VYUY v4l2_fourcc('V', 'Y', 'U', 'Y') /* 16 YUV 4:2:2 */
- #define V4L2_PIX_FMT_YUV422P v4l2_fourcc('4', '2', '2', 'P') /* 16 YVU422 planar */
- #define V4L2_PIX_FMT_YUV411P v4l2_fourcc('4', '1', '1', 'P') /* 16 YVU411 planar */
- #define V4L2_PIX_FMT_Y41P v4l2_fourcc('Y', '4', '1', 'P') /* 12 YUV 4:1:1 */
- #define V4L2_PIX_FMT_YUV444 v4l2_fourcc('Y', '4', '4', '4') /* 16 xxxxyyyy uuuuvvvv */
- #define V4L2_PIX_FMT_YUV555 v4l2_fourcc('Y', 'U', 'V', 'O') /* 16 YUV-5-5-5 */
- #define V4L2_PIX_FMT_YUV565 v4l2_fourcc('Y', 'U', 'V', 'P') /* 16 YUV-5-6-5 */
- #define V4L2_PIX_FMT_YUV32 v4l2_fourcc('Y', 'U', 'V', '4') /* 32 YUV-8-8-8-8 */
- #define V4L2_PIX_FMT_YUV410 v4l2_fourcc('Y', 'U', 'V', '9') /* 9 YUV 4:1:0 */
- #define V4L2_PIX_FMT_YUV420 v4l2_fourcc('Y', 'U', '1', '2') /* 12 YUV 4:2:0 */
- #define V4L2_PIX_FMT_HI240 v4l2_fourcc('H', 'I', '2', '4') /* 8 8-bit color */
- #define V4L2_PIX_FMT_HM12 v4l2_fourcc('H', 'M', '1', '2') /* 8 YUV 4:2:0 16x16 macroblocks */
- #define V4L2_PIX_FMT_M420 v4l2_fourcc('M', '4', '2', '0') /* 12 YUV 4:2:0 2 lines y, 1 line uv interleaved */
-
- /* two planes -- one Y, one Cr + Cb interleaved */
- #define V4L2_PIX_FMT_NV12 v4l2_fourcc('N', 'V', '1', '2') /* 12 Y/CbCr 4:2:0 */
- #define V4L2_PIX_FMT_NV21 v4l2_fourcc('N', 'V', '2', '1') /* 12 Y/CrCb 4:2:0 */
- #define V4L2_PIX_FMT_NV16 v4l2_fourcc('N', 'V', '1', '6') /* 16 Y/CbCr 4:2:2 */
- #define V4L2_PIX_FMT_NV61 v4l2_fourcc('N', 'V', '6', '1') /* 16 Y/CrCb 4:2:2 */
- #define V4L2_PIX_FMT_NV24 v4l2_fourcc('N', 'V', '2', '4') /* 24 Y/CbCr 4:4:4 */
- #define V4L2_PIX_FMT_NV42 v4l2_fourcc('N', 'V', '4', '2') /* 24 Y/CrCb 4:4:4 */
-
- /* two non contiguous planes - one Y, one Cr + Cb interleaved */
- #define V4L2_PIX_FMT_NV12M v4l2_fourcc('N', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 */
- #define V4L2_PIX_FMT_NV21M v4l2_fourcc('N', 'M', '2', '1') /* 21 Y/CrCb 4:2:0 */
- #define V4L2_PIX_FMT_NV16M v4l2_fourcc('N', 'M', '1', '6') /* 16 Y/CbCr 4:2:2 */
- #define V4L2_PIX_FMT_NV61M v4l2_fourcc('N', 'M', '6', '1') /* 16 Y/CrCb 4:2:2 */
- #define V4L2_PIX_FMT_NV12MT v4l2_fourcc('T', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 64x32 macroblocks */
- #define V4L2_PIX_FMT_NV12MT_16X16 v4l2_fourcc('V', 'M', '1', '2') /* 12 Y/CbCr 4:2:0 16x16 macroblocks */
-
- /* three non contiguous planes - Y, Cb, Cr */
- #define V4L2_PIX_FMT_YUV420M v4l2_fourcc('Y', 'M', '1', '2') /* 12 YUV420 planar */
- #define V4L2_PIX_FMT_YVU420M v4l2_fourcc('Y', 'M', '2', '1') /* 12 YVU420 planar */
- #define V4L2_PIX_FMT_YUV422M v4l2_fourcc('Y', 'M', '1', '6') /* 16 YUV422 planar */
- #define V4L2_PIX_FMT_YVU422M v4l2_fourcc('Y', 'M', '6', '1') /* 16 YVU422 planar */
- #define V4L2_PIX_FMT_YUV444M v4l2_fourcc('Y', 'M', '2', '4') /* 24 YUV444 planar */
- #define V4L2_PIX_FMT_YVU444M v4l2_fourcc('Y', 'M', '4', '2') /* 24 YVU444 planar */
-
- /* Bayer formats - see http://www.siliconimaging.com/RGB%20Bayer.htm */
- #define V4L2_PIX_FMT_SBGGR8 v4l2_fourcc('B', 'A', '8', '1') /* 8 BGBG.. GRGR.. */
- #define V4L2_PIX_FMT_SGBRG8 v4l2_fourcc('G', 'B', 'R', 'G') /* 8 GBGB.. RGRG.. */
- #define V4L2_PIX_FMT_SGRBG8 v4l2_fourcc('G', 'R', 'B', 'G') /* 8 GRGR.. BGBG.. */
- #define V4L2_PIX_FMT_SRGGB8 v4l2_fourcc('R', 'G', 'G', 'B') /* 8 RGRG.. GBGB.. */
- #define V4L2_PIX_FMT_SBGGR10 v4l2_fourcc('B', 'G', '1', '0') /* 10 BGBG.. GRGR.. */
- #define V4L2_PIX_FMT_SGBRG10 v4l2_fourcc('G', 'B', '1', '0') /* 10 GBGB.. RGRG.. */
- #define V4L2_PIX_FMT_SGRBG10 v4l2_fourcc('B', 'A', '1', '0') /* 10 GRGR.. BGBG.. */
- #define V4L2_PIX_FMT_SRGGB10 v4l2_fourcc('R', 'G', '1', '0') /* 10 RGRG.. GBGB.. */
- /* 10bit raw bayer packed, 5 bytes for every 4 pixels */
- #define V4L2_PIX_FMT_SBGGR10P v4l2_fourcc('p', 'B', 'A', 'A')
- #define V4L2_PIX_FMT_SGBRG10P v4l2_fourcc('p', 'G', 'A', 'A')
- #define V4L2_PIX_FMT_SGRBG10P v4l2_fourcc('p', 'g', 'A', 'A')
- #define V4L2_PIX_FMT_SRGGB10P v4l2_fourcc('p', 'R', 'A', 'A')
- /* 10bit raw bayer a-law compressed to 8 bits */
- #define V4L2_PIX_FMT_SBGGR10ALAW8 v4l2_fourcc('a', 'B', 'A', '8')
- #define V4L2_PIX_FMT_SGBRG10ALAW8 v4l2_fourcc('a', 'G', 'A', '8')
- #define V4L2_PIX_FMT_SGRBG10ALAW8 v4l2_fourcc('a', 'g', 'A', '8')
- #define V4L2_PIX_FMT_SRGGB10ALAW8 v4l2_fourcc('a', 'R', 'A', '8')
- /* 10bit raw bayer DPCM compressed to 8 bits */
- #define V4L2_PIX_FMT_SBGGR10DPCM8 v4l2_fourcc('b', 'B', 'A', '8')
- #define V4L2_PIX_FMT_SGBRG10DPCM8 v4l2_fourcc('b', 'G', 'A', '8')
- #define V4L2_PIX_FMT_SGRBG10DPCM8 v4l2_fourcc('B', 'D', '1', '0')
- #define V4L2_PIX_FMT_SRGGB10DPCM8 v4l2_fourcc('b', 'R', 'A', '8')
- #define V4L2_PIX_FMT_SBGGR12 v4l2_fourcc('B', 'G', '1', '2') /* 12 BGBG.. GRGR.. */
- #define V4L2_PIX_FMT_SGBRG12 v4l2_fourcc('G', 'B', '1', '2') /* 12 GBGB.. RGRG.. */
- #define V4L2_PIX_FMT_SGRBG12 v4l2_fourcc('B', 'A', '1', '2') /* 12 GRGR.. BGBG.. */
- #define V4L2_PIX_FMT_SRGGB12 v4l2_fourcc('R', 'G', '1', '2') /* 12 RGRG.. GBGB.. */
- #define V4L2_PIX_FMT_SBGGR16 v4l2_fourcc('B', 'Y', 'R', '2') /* 16 BGBG.. GRGR.. */
-
- /* compressed formats */
- #define V4L2_PIX_FMT_MJPEG v4l2_fourcc('M', 'J', 'P', 'G') /* Motion-JPEG */
- #define V4L2_PIX_FMT_JPEG v4l2_fourcc('J', 'P', 'E', 'G') /* JFIF JPEG */
- #define V4L2_PIX_FMT_DV v4l2_fourcc('d', 'v', 's', 'd') /* 1394 */
- #define V4L2_PIX_FMT_MPEG v4l2_fourcc('M', 'P', 'E', 'G') /* MPEG-1/2/4 Multiplexed */
- #define V4L2_PIX_FMT_H264 v4l2_fourcc('H', '2', '6', '4') /* H264 with start codes */
- #define V4L2_PIX_FMT_H264_NO_SC v4l2_fourcc('A', 'V', 'C', '1') /* H264 without start codes */
- #define V4L2_PIX_FMT_H264_MVC v4l2_fourcc('M', '2', '6', '4') /* H264 MVC */
- #define V4L2_PIX_FMT_H263 v4l2_fourcc('H', '2', '6', '3') /* H263 */
- #define V4L2_PIX_FMT_MPEG1 v4l2_fourcc('M', 'P', 'G', '1') /* MPEG-1 ES */
- #define V4L2_PIX_FMT_MPEG2 v4l2_fourcc('M', 'P', 'G', '2') /* MPEG-2 ES */
- #define V4L2_PIX_FMT_MPEG4 v4l2_fourcc('M', 'P', 'G', '4') /* MPEG-4 part 2 ES */
- #define V4L2_PIX_FMT_XVID v4l2_fourcc('X', 'V', 'I', 'D') /* Xvid */
- #define V4L2_PIX_FMT_VC1_ANNEX_G v4l2_fourcc('V', 'C', '1', 'G') /* SMPTE 421M Annex G compliant stream */
- #define V4L2_PIX_FMT_VC1_ANNEX_L v4l2_fourcc('V', 'C', '1', 'L') /* SMPTE 421M Annex L compliant stream */
- #define V4L2_PIX_FMT_VP8 v4l2_fourcc('V', 'P', '8', '0') /* VP8 */
-
- /* Vendor-specific formats */
- #define V4L2_PIX_FMT_CPIA1 v4l2_fourcc('C', 'P', 'I', 'A') /* cpia1 YUV */
- #define V4L2_PIX_FMT_WNVA v4l2_fourcc('W', 'N', 'V', 'A') /* Winnov hw compress */
- #define V4L2_PIX_FMT_SN9C10X v4l2_fourcc('S', '9', '1', '0') /* SN9C10x compression */
- #define V4L2_PIX_FMT_SN9C20X_I420 v4l2_fourcc('S', '9', '2', '0') /* SN9C20x YUV 4:2:0 */
- #define V4L2_PIX_FMT_PWC1 v4l2_fourcc('P', 'W', 'C', '1') /* pwc older webcam */
- #define V4L2_PIX_FMT_PWC2 v4l2_fourcc('P', 'W', 'C', '2') /* pwc newer webcam */
- #define V4L2_PIX_FMT_ET61X251 v4l2_fourcc('E', '6', '2', '5') /* ET61X251 compression */
- #define V4L2_PIX_FMT_SPCA501 v4l2_fourcc('S', '5', '0', '1') /* YUYV per line */
- #define V4L2_PIX_FMT_SPCA505 v4l2_fourcc('S', '5', '0', '5') /* YYUV per line */
- #define V4L2_PIX_FMT_SPCA508 v4l2_fourcc('S', '5', '0', '8') /* YUVY per line */
- #define V4L2_PIX_FMT_SPCA561 v4l2_fourcc('S', '5', '6', '1') /* compressed GBRG bayer */
- #define V4L2_PIX_FMT_PAC207 v4l2_fourcc('P', '2', '0', '7') /* compressed BGGR bayer */
- #define V4L2_PIX_FMT_MR97310A v4l2_fourcc('M', '3', '1', '0') /* compressed BGGR bayer */
- #define V4L2_PIX_FMT_JL2005BCD v4l2_fourcc('J', 'L', '2', '0') /* compressed RGGB bayer */
- #define V4L2_PIX_FMT_SN9C2028 v4l2_fourcc('S', 'O', 'N', 'X') /* compressed GBRG bayer */
- #define V4L2_PIX_FMT_SQ905C v4l2_fourcc('9', '0', '5', 'C') /* compressed RGGB bayer */
- #define V4L2_PIX_FMT_PJPG v4l2_fourcc('P', 'J', 'P', 'G') /* Pixart 73xx JPEG */
- #define V4L2_PIX_FMT_OV511 v4l2_fourcc('O', '5', '1', '1') /* ov511 JPEG */
- #define V4L2_PIX_FMT_OV518 v4l2_fourcc('O', '5', '1', '8') /* ov518 JPEG */
- #define V4L2_PIX_FMT_STV0680 v4l2_fourcc('S', '6', '8', '0') /* stv0680 bayer */
- #define V4L2_PIX_FMT_TM6000 v4l2_fourcc('T', 'M', '6', '0') /* tm5600/tm60x0 */
- #define V4L2_PIX_FMT_CIT_YYVYUY v4l2_fourcc('C', 'I', 'T', 'V') /* one line of Y then 1 line of VYUY */
- #define V4L2_PIX_FMT_KONICA420 v4l2_fourcc('K', 'O', 'N', 'I') /* YUV420 planar in blocks of 256 pixels */
- #define V4L2_PIX_FMT_JPGL v4l2_fourcc('J', 'P', 'G', 'L') /* JPEG-Lite */
- #define V4L2_PIX_FMT_SE401 v4l2_fourcc('S', '4', '0', '1') /* se401 janggu compressed rgb */
- #define V4L2_PIX_FMT_S5C_UYVY_JPG v4l2_fourcc('S', '5', 'C', 'I') /* S5C73M3 interleaved UYVY/JPEG */
- #define V4L2_PIX_FMT_Y8I v4l2_fourcc('Y', '8', 'I', ' ') /* Greyscale 8-bit L/R interleaved */
- #define V4L2_PIX_FMT_Y12I v4l2_fourcc('Y', '1', '2', 'I') /* Greyscale 12-bit L/R interleaved */
- #define V4L2_PIX_FMT_Z16 v4l2_fourcc('Z', '1', '6', ' ') /* Depth data 16-bit */
-
- /* SDR formats - used only for Software Defined Radio devices */
- #define V4L2_SDR_FMT_CU8 v4l2_fourcc('C', 'U', '0', '8') /* IQ u8 */
- #define V4L2_SDR_FMT_CU16LE v4l2_fourcc('C', 'U', '1', '6') /* IQ u16le */
- #define V4L2_SDR_FMT_CS8 v4l2_fourcc('C', 'S', '0', '8') /* complex s8 */
- #define V4L2_SDR_FMT_CS14LE v4l2_fourcc('C', 'S', '1', '4') /* complex s14le */
- #define V4L2_SDR_FMT_RU12LE v4l2_fourcc('R', 'U', '1', '2') /* real u12le */
-
- /* priv field value to indicates that subsequent fields are valid. */
- #define V4L2_PIX_FMT_PRIV_MAGIC 0xfeedcafe
-
- /* Flags */
- #define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA 0x00000001
-
- /*
- * F O R M A T E N U M E R A T I O N
- */
- struct v4l2_fmtdesc {
- __u32 index; /* Format number */
- __u32 type; /* enum v4l2_buf_type */
- __u32 flags;
- __u8 description[32]; /* Description string */
- __u32 pixelformat; /* Format fourcc */
- __u32 reserved[4];
- };
-
- #define V4L2_FMT_FLAG_COMPRESSED 0x0001
- #define V4L2_FMT_FLAG_EMULATED 0x0002
-
- /* Frame Size and frame rate enumeration */
- /*
- * F R A M E S I Z E E N U M E R A T I O N
- */
- enum v4l2_frmsizetypes {
- V4L2_FRMSIZE_TYPE_DISCRETE = 1,
- V4L2_FRMSIZE_TYPE_CONTINUOUS = 2,
- V4L2_FRMSIZE_TYPE_STEPWISE = 3,
- };
-
- struct v4l2_frmsize_discrete {
- __u32 width; /* Frame width [pixel] */
- __u32 height; /* Frame height [pixel] */
- };
-
- struct v4l2_frmsize_stepwise {
- __u32 min_width; /* Minimum frame width [pixel] */
- __u32 max_width; /* Maximum frame width [pixel] */
- __u32 step_width; /* Frame width step size [pixel] */
- __u32 min_height; /* Minimum frame height [pixel] */
- __u32 max_height; /* Maximum frame height [pixel] */
- __u32 step_height; /* Frame height step size [pixel] */
- };
-
- struct v4l2_frmsizeenum {
- __u32 index; /* Frame size number */
- __u32 pixel_format; /* Pixel format */
- __u32 type; /* Frame size type the device supports. */
-
- union { /* Frame size */
- struct v4l2_frmsize_discrete discrete;
- struct v4l2_frmsize_stepwise stepwise;
- };
-
- __u32 reserved[2]; /* Reserved space for future use */
- };
-
- /*
- * F R A M E R A T E E N U M E R A T I O N
- */
- enum v4l2_frmivaltypes {
- V4L2_FRMIVAL_TYPE_DISCRETE = 1,
- V4L2_FRMIVAL_TYPE_CONTINUOUS = 2,
- V4L2_FRMIVAL_TYPE_STEPWISE = 3,
- };
-
- struct v4l2_frmival_stepwise {
- struct v4l2_fract min; /* Minimum frame interval [s] */
- struct v4l2_fract max; /* Maximum frame interval [s] */
- struct v4l2_fract step; /* Frame interval step size [s] */
- };
-
- struct v4l2_frmivalenum {
- __u32 index; /* Frame format index */
- __u32 pixel_format; /* Pixel format */
- __u32 width; /* Frame width */
- __u32 height; /* Frame height */
- __u32 type; /* Frame interval type the device supports. */
-
- union { /* Frame interval */
- struct v4l2_fract discrete;
- struct v4l2_frmival_stepwise stepwise;
- };
-
- __u32 reserved[2]; /* Reserved space for future use */
- };
-
- /*
- * T I M E C O D E
- */
- struct v4l2_timecode {
- __u32 type;
- __u32 flags;
- __u8 frames;
- __u8 seconds;
- __u8 minutes;
- __u8 hours;
- __u8 userbits[4];
- };
-
- /* Type */
- #define V4L2_TC_TYPE_24FPS 1
- #define V4L2_TC_TYPE_25FPS 2
- #define V4L2_TC_TYPE_30FPS 3
- #define V4L2_TC_TYPE_50FPS 4
- #define V4L2_TC_TYPE_60FPS 5
-
- /* Flags */
- #define V4L2_TC_FLAG_DROPFRAME 0x0001 /* "drop-frame" mode */
- #define V4L2_TC_FLAG_COLORFRAME 0x0002
- #define V4L2_TC_USERBITS_field 0x000C
- #define V4L2_TC_USERBITS_USERDEFINED 0x0000
- #define V4L2_TC_USERBITS_8BITCHARS 0x0008
- /* The above is based on SMPTE timecodes */
-
- struct v4l2_jpegcompression {
- int quality;
-
- int APPn; /* Number of APP segment to be written,
- * must be 0..15 */
- int APP_len; /* Length of data in JPEG APPn segment */
- char APP_data[60]; /* Data in the JPEG APPn segment. */
-
- int COM_len; /* Length of data in JPEG COM segment */
- char COM_data[60]; /* Data in JPEG COM segment */
-
- __u32 jpeg_markers; /* Which markers should go into the JPEG
- * output. Unless you exactly know what
- * you do, leave them untouched.
- * Including less markers will make the
- * resulting code smaller, but there will
- * be fewer applications which can read it.
- * The presence of the APP and COM marker
- * is influenced by APP_len and COM_len
- * ONLY, not by this property! */
-
- #define V4L2_JPEG_MARKER_DHT (1<<3) /* Define Huffman Tables */
- #define V4L2_JPEG_MARKER_DQT (1<<4) /* Define Quantization Tables */
- #define V4L2_JPEG_MARKER_DRI (1<<5) /* Define Restart Interval */
- #define V4L2_JPEG_MARKER_COM (1<<6) /* Comment segment */
- #define V4L2_JPEG_MARKER_APP (1<<7) /* App segment, driver will
- * always use APP0 */
- };
-
- /*
- * M E M O R Y - M A P P I N G B U F F E R S
- */
- struct v4l2_requestbuffers {
- __u32 count;
- __u32 type; /* enum v4l2_buf_type */
- __u32 memory; /* enum v4l2_memory */
- __u32 reserved[2];
- };
-
- /**
- * struct v4l2_plane - plane info for multi-planar buffers
- * @bytesused: number of bytes occupied by data in the plane (payload)
- * @length: size of this plane (NOT the payload) in bytes
- * @mem_offset: when memory in the associated struct v4l2_buffer is
- * V4L2_MEMORY_MMAP, equals the offset from the start of
- * the device memory for this plane (or is a "cookie" that
- * should be passed to mmap() called on the video node)
- * @userptr: when memory is V4L2_MEMORY_USERPTR, a userspace pointer
- * pointing to this plane
- * @fd: when memory is V4L2_MEMORY_DMABUF, a userspace file
- * descriptor associated with this plane
- * @data_offset: offset in the plane to the start of data; usually 0,
- * unless there is a header in front of the data
- *
- * Multi-planar buffers consist of one or more planes, e.g. an YCbCr buffer
- * with two planes can have one plane for Y, and another for interleaved CbCr
- * components. Each plane can reside in a separate memory buffer, or even in
- * a completely separate memory node (e.g. in embedded devices).
- */
- struct v4l2_plane {
- __u32 bytesused;
- __u32 length;
- union {
- __u32 mem_offset;
- unsigned long userptr;
- __s32 fd;
- } m;
- __u32 data_offset;
- __u32 reserved[11];
- };
-
- /**
- * struct v4l2_buffer - video buffer info
- * @index: id number of the buffer
- * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
- * multiplanar buffers);
- * @bytesused: number of bytes occupied by data in the buffer (payload);
- * unused (set to 0) for multiplanar buffers
- * @flags: buffer informational flags
- * @field: enum v4l2_field; field order of the image in the buffer
- * @timestamp: frame timestamp
- * @timecode: frame timecode
- * @sequence: sequence count of this frame
- * @memory: enum v4l2_memory; the method, in which the actual video data is
- * passed
- * @offset: for non-multiplanar buffers with memory == V4L2_MEMORY_MMAP;
- * offset from the start of the device memory for this plane,
- * (or a "cookie" that should be passed to mmap() as offset)
- * @userptr: for non-multiplanar buffers with memory == V4L2_MEMORY_USERPTR;
- * a userspace pointer pointing to this buffer
- * @fd: for non-multiplanar buffers with memory == V4L2_MEMORY_DMABUF;
- * a userspace file descriptor associated with this buffer
- * @planes: for multiplanar buffers; userspace pointer to the array of plane
- * info structs for this buffer
- * @length: size in bytes of the buffer (NOT its payload) for single-plane
- * buffers (when type != *_MPLANE); number of elements in the
- * planes array for multi-plane buffers
- *
- * Contains data exchanged by application and driver using one of the Streaming
- * I/O methods.
- */
- struct v4l2_buffer {
- __u32 index;
- __u32 type;
- __u32 bytesused;
- __u32 flags;
- __u32 field;
- struct timeval timestamp;
- struct v4l2_timecode timecode;
- __u32 sequence;
-
- /* memory location */
- __u32 memory;
- union {
- __u32 offset;
- unsigned long userptr;
- struct v4l2_plane *planes;
- __s32 fd;
- } m;
- __u32 length;
- __u32 reserved2;
- __u32 reserved;
- };
-
- /* Flags for 'flags' field */
- /* Buffer is mapped (flag) */
- #define V4L2_BUF_FLAG_MAPPED 0x00000001
- /* Buffer is queued for processing */
- #define V4L2_BUF_FLAG_QUEUED 0x00000002
- /* Buffer is ready */
- #define V4L2_BUF_FLAG_DONE 0x00000004
- /* Image is a keyframe (I-frame) */
- #define V4L2_BUF_FLAG_KEYFRAME 0x00000008
- /* Image is a P-frame */
- #define V4L2_BUF_FLAG_PFRAME 0x00000010
- /* Image is a B-frame */
- #define V4L2_BUF_FLAG_BFRAME 0x00000020
- /* Buffer is ready, but the data contained within is corrupted. */
- #define V4L2_BUF_FLAG_ERROR 0x00000040
- /* timecode field is valid */
- #define V4L2_BUF_FLAG_TIMECODE 0x00000100
- /* Buffer is prepared for queuing */
- #define V4L2_BUF_FLAG_PREPARED 0x00000400
- /* Cache handling flags */
- #define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE 0x00000800
- #define V4L2_BUF_FLAG_NO_CACHE_CLEAN 0x00001000
- /* Timestamp type */
- #define V4L2_BUF_FLAG_TIMESTAMP_MASK 0x0000e000
- #define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN 0x00000000
- #define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC 0x00002000
- #define V4L2_BUF_FLAG_TIMESTAMP_COPY 0x00004000
- /* Timestamp sources. */
- #define V4L2_BUF_FLAG_TSTAMP_SRC_MASK 0x00070000
- #define V4L2_BUF_FLAG_TSTAMP_SRC_EOF 0x00000000
- #define V4L2_BUF_FLAG_TSTAMP_SRC_SOE 0x00010000
- /* mem2mem encoder/decoder */
- #define V4L2_BUF_FLAG_LAST 0x00100000
-
- /**
- * struct v4l2_exportbuffer - export of video buffer as DMABUF file descriptor
- *
- * @index: id number of the buffer
- * @type: enum v4l2_buf_type; buffer type (type == *_MPLANE for
- * multiplanar buffers);
- * @plane: index of the plane to be exported, 0 for single plane queues
- * @flags: flags for newly created file, currently only O_CLOEXEC is
- * supported, refer to manual of open syscall for more details
- * @fd: file descriptor associated with DMABUF (set by driver)
- *
- * Contains data used for exporting a video buffer as DMABUF file descriptor.
- * The buffer is identified by a 'cookie' returned by VIDIOC_QUERYBUF
- * (identical to the cookie used to mmap() the buffer to userspace). All
- * reserved fields must be set to zero. The field reserved0 is expected to
- * become a structure 'type' allowing an alternative layout of the structure
- * content. Therefore this field should not be used for any other extensions.
- */
- struct v4l2_exportbuffer {
- __u32 type; /* enum v4l2_buf_type */
- __u32 index;
- __u32 plane;
- __u32 flags;
- __s32 fd;
- __u32 reserved[11];
- };
-
- /*
- * O V E R L A Y P R E V I E W
- */
- struct v4l2_framebuffer {
- __u32 capability;
- __u32 flags;
- /* FIXME: in theory we should pass something like PCI device + memory
- * region + offset instead of some physical address */
- void *base;
- struct {
- __u32 width;
- __u32 height;
- __u32 pixelformat;
- __u32 field; /* enum v4l2_field */
- __u32 bytesperline; /* for padding, zero if unused */
- __u32 sizeimage;
- __u32 colorspace; /* enum v4l2_colorspace */
- __u32 priv; /* reserved field, set to 0 */
- } fmt;
- };
- /* Flags for the 'capability' field. Read only */
- #define V4L2_FBUF_CAP_EXTERNOVERLAY 0x0001
- #define V4L2_FBUF_CAP_CHROMAKEY 0x0002
- #define V4L2_FBUF_CAP_LIST_CLIPPING 0x0004
- #define V4L2_FBUF_CAP_BITMAP_CLIPPING 0x0008
- #define V4L2_FBUF_CAP_LOCAL_ALPHA 0x0010
- #define V4L2_FBUF_CAP_GLOBAL_ALPHA 0x0020
- #define V4L2_FBUF_CAP_LOCAL_INV_ALPHA 0x0040
- #define V4L2_FBUF_CAP_SRC_CHROMAKEY 0x0080
- /* Flags for the 'flags' field. */
- #define V4L2_FBUF_FLAG_PRIMARY 0x0001
- #define V4L2_FBUF_FLAG_OVERLAY 0x0002
- #define V4L2_FBUF_FLAG_CHROMAKEY 0x0004
- #define V4L2_FBUF_FLAG_LOCAL_ALPHA 0x0008
- #define V4L2_FBUF_FLAG_GLOBAL_ALPHA 0x0010
- #define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA 0x0020
- #define V4L2_FBUF_FLAG_SRC_CHROMAKEY 0x0040
-
- struct v4l2_clip {
- struct v4l2_rect c;
- struct v4l2_clip __user *next;
- };
-
- struct v4l2_window {
- struct v4l2_rect w;
- __u32 field; /* enum v4l2_field */
- __u32 chromakey;
- struct v4l2_clip __user *clips;
- __u32 clipcount;
- void __user *bitmap;
- __u8 global_alpha;
- };
-
- /*
- * C A P T U R E P A R A M E T E R S
- */
- struct v4l2_captureparm {
- __u32 capability; /* Supported modes */
- __u32 capturemode; /* Current mode */
- struct v4l2_fract timeperframe; /* Time per frame in seconds */
- __u32 extendedmode; /* Driver-specific extensions */
- __u32 readbuffers; /* # of buffers for read */
- __u32 reserved[4];
- };
-
- /* Flags for 'capability' and 'capturemode' fields */
- #define V4L2_MODE_HIGHQUALITY 0x0001 /* High quality imaging mode */
- #define V4L2_CAP_TIMEPERFRAME 0x1000 /* timeperframe field is supported */
-
- struct v4l2_outputparm {
- __u32 capability; /* Supported modes */
- __u32 outputmode; /* Current mode */
- struct v4l2_fract timeperframe; /* Time per frame in seconds */
- __u32 extendedmode; /* Driver-specific extensions */
- __u32 writebuffers; /* # of buffers for write */
- __u32 reserved[4];
- };
-
- /*
- * I N P U T I M A G E C R O P P I N G
- */
- struct v4l2_cropcap {
- __u32 type; /* enum v4l2_buf_type */
- struct v4l2_rect bounds;
- struct v4l2_rect defrect;
- struct v4l2_fract pixelaspect;
- };
-
- struct v4l2_crop {
- __u32 type; /* enum v4l2_buf_type */
- struct v4l2_rect c;
- };
-
- /**
- * struct v4l2_selection - selection info
- * @type: buffer type (do not use *_MPLANE types)
- * @target: Selection target, used to choose one of possible rectangles;
- * defined in v4l2-common.h; V4L2_SEL_TGT_* .
- * @flags: constraints flags, defined in v4l2-common.h; V4L2_SEL_FLAG_*.
- * @r: coordinates of selection window
- * @reserved: for future use, rounds structure size to 64 bytes, set to zero
- *
- * Hardware may use multiple helper windows to process a video stream.
- * The structure is used to exchange this selection areas between
- * an application and a driver.
- */
- struct v4l2_selection {
- __u32 type;
- __u32 target;
- __u32 flags;
- struct v4l2_rect r;
- __u32 reserved[9];
- };
-
-
- /*
- * A N A L O G V I D E O S T A N D A R D
- */
-
- typedef __u64 v4l2_std_id;
-
- /* one bit for each */
- #define V4L2_STD_PAL_B ((v4l2_std_id)0x00000001)
- #define V4L2_STD_PAL_B1 ((v4l2_std_id)0x00000002)
- #define V4L2_STD_PAL_G ((v4l2_std_id)0x00000004)
- #define V4L2_STD_PAL_H ((v4l2_std_id)0x00000008)
- #define V4L2_STD_PAL_I ((v4l2_std_id)0x00000010)
- #define V4L2_STD_PAL_D ((v4l2_std_id)0x00000020)
- #define V4L2_STD_PAL_D1 ((v4l2_std_id)0x00000040)
- #define V4L2_STD_PAL_K ((v4l2_std_id)0x00000080)
-
- #define V4L2_STD_PAL_M ((v4l2_std_id)0x00000100)
- #define V4L2_STD_PAL_N ((v4l2_std_id)0x00000200)
- #define V4L2_STD_PAL_Nc ((v4l2_std_id)0x00000400)
- #define V4L2_STD_PAL_60 ((v4l2_std_id)0x00000800)
-
- #define V4L2_STD_NTSC_M ((v4l2_std_id)0x00001000) /* BTSC */
- #define V4L2_STD_NTSC_M_JP ((v4l2_std_id)0x00002000) /* EIA-J */
- #define V4L2_STD_NTSC_443 ((v4l2_std_id)0x00004000)
- #define V4L2_STD_NTSC_M_KR ((v4l2_std_id)0x00008000) /* FM A2 */
-
- #define V4L2_STD_SECAM_B ((v4l2_std_id)0x00010000)
- #define V4L2_STD_SECAM_D ((v4l2_std_id)0x00020000)
- #define V4L2_STD_SECAM_G ((v4l2_std_id)0x00040000)
- #define V4L2_STD_SECAM_H ((v4l2_std_id)0x00080000)
- #define V4L2_STD_SECAM_K ((v4l2_std_id)0x00100000)
- #define V4L2_STD_SECAM_K1 ((v4l2_std_id)0x00200000)
- #define V4L2_STD_SECAM_L ((v4l2_std_id)0x00400000)
- #define V4L2_STD_SECAM_LC ((v4l2_std_id)0x00800000)
-
- /* ATSC/HDTV */
- #define V4L2_STD_ATSC_8_VSB ((v4l2_std_id)0x01000000)
- #define V4L2_STD_ATSC_16_VSB ((v4l2_std_id)0x02000000)
-
- /* FIXME:
- Although std_id is 64 bits, there is an issue on PPC32 architecture that
- makes switch(__u64) to break. So, there's a hack on v4l2-common.c rounding
- this value to 32 bits.
- As, currently, the max value is for V4L2_STD_ATSC_16_VSB (30 bits wide),
- it should work fine. However, if needed to add more than two standards,
- v4l2-common.c should be fixed.
- */
-
- /*
- * Some macros to merge video standards in order to make live easier for the
- * drivers and V4L2 applications
- */
-
- /*
- * "Common" NTSC/M - It should be noticed that V4L2_STD_NTSC_443 is
- * Missing here.
- */
- #define V4L2_STD_NTSC (V4L2_STD_NTSC_M |
- V4L2_STD_NTSC_M_JP |
- V4L2_STD_NTSC_M_KR)
- /* Secam macros */
- #define V4L2_STD_SECAM_DK (V4L2_STD_SECAM_D |
- V4L2_STD_SECAM_K |
- V4L2_STD_SECAM_K1)
- /* All Secam Standards */
- #define V4L2_STD_SECAM (V4L2_STD_SECAM_B |
- V4L2_STD_SECAM_G |
- V4L2_STD_SECAM_H |
- V4L2_STD_SECAM_DK |
- V4L2_STD_SECAM_L |
- V4L2_STD_SECAM_LC)
- /* PAL macros */
- #define V4L2_STD_PAL_BG (V4L2_STD_PAL_B |
- V4L2_STD_PAL_B1 |
- V4L2_STD_PAL_G)
- #define V4L2_STD_PAL_DK (V4L2_STD_PAL_D |
- V4L2_STD_PAL_D1 |
- V4L2_STD_PAL_K)
- /*
- * "Common" PAL - This macro is there to be compatible with the old
- * V4L1 concept of "PAL": /BGDKHI.
- * Several PAL standards are missing here: /M, /N and /Nc
- */
- #define V4L2_STD_PAL (V4L2_STD_PAL_BG |
- V4L2_STD_PAL_DK |
- V4L2_STD_PAL_H |
- V4L2_STD_PAL_I)
- /* Chroma "agnostic" standards */
- #define V4L2_STD_B (V4L2_STD_PAL_B |
- V4L2_STD_PAL_B1 |
- V4L2_STD_SECAM_B)
- #define V4L2_STD_G (V4L2_STD_PAL_G |
- V4L2_STD_SECAM_G)
- #define V4L2_STD_H (V4L2_STD_PAL_H |
- V4L2_STD_SECAM_H)
- #define V4L2_STD_L (V4L2_STD_SECAM_L |
- V4L2_STD_SECAM_LC)
- #define V4L2_STD_GH (V4L2_STD_G |
- V4L2_STD_H)
- #define V4L2_STD_DK (V4L2_STD_PAL_DK |
- V4L2_STD_SECAM_DK)
- #define V4L2_STD_BG (V4L2_STD_B |
- V4L2_STD_G)
- #define V4L2_STD_MN (V4L2_STD_PAL_M |
- V4L2_STD_PAL_N |
- V4L2_STD_PAL_Nc |
- V4L2_STD_NTSC)
-
- /* Standards where MTS/BTSC stereo could be found */
- #define V4L2_STD_MTS (V4L2_STD_NTSC_M |
- V4L2_STD_PAL_M |
- V4L2_STD_PAL_N |
- V4L2_STD_PAL_Nc)
-
- /* Standards for Countries with 60Hz Line frequency */
- #define V4L2_STD_525_60 (V4L2_STD_PAL_M |
- V4L2_STD_PAL_60 |
- V4L2_STD_NTSC |
- V4L2_STD_NTSC_443)
- /* Standards for Countries with 50Hz Line frequency */
- #define V4L2_STD_625_50 (V4L2_STD_PAL |
- V4L2_STD_PAL_N |
- V4L2_STD_PAL_Nc |
- V4L2_STD_SECAM)
-
- #define V4L2_STD_ATSC (V4L2_STD_ATSC_8_VSB |
- V4L2_STD_ATSC_16_VSB)
- /* Macros with none and all analog standards */
- #define V4L2_STD_UNKNOWN 0
- #define V4L2_STD_ALL (V4L2_STD_525_60 |
- V4L2_STD_625_50)
-
- struct v4l2_standard {
- __u32 index;
- v4l2_std_id id;
- __u8 name[24];
- struct v4l2_fract frameperiod; /* Frames, not fields */
- __u32 framelines;
- __u32 reserved[4];
- };
-
- /*
- * D V B T T I M I N G S
- */
-
- /** struct v4l2_bt_timings - BT.656/BT.1120 timing data
- * @width: total width of the active video in pixels
- * @height: total height of the active video in lines
- * @interlaced: Interlaced or progressive
- * @polarities: Positive or negative polarities
- * @pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
- * @hfrontporch:Horizontal front porch in pixels
- * @hsync: Horizontal Sync length in pixels
- * @hbackporch: Horizontal back porch in pixels
- * @vfrontporch:Vertical front porch in lines
- * @vsync: Vertical Sync length in lines
- * @vbackporch: Vertical back porch in lines
- * @il_vfrontporch:Vertical front porch for the even field
- * (aka field 2) of interlaced field formats
- * @il_vsync: Vertical Sync length for the even field
- * (aka field 2) of interlaced field formats
- * @il_vbackporch:Vertical back porch for the even field
- * (aka field 2) of interlaced field formats
- * @standards: Standards the timing belongs to
- * @flags: Flags
- * @reserved: Reserved fields, must be zeroed.
- *
- * A note regarding vertical interlaced timings: height refers to the total
- * height of the active video frame (= two fields). The blanking timings refer
- * to the blanking of each field. So the height of the total frame is
- * calculated as follows:
- *
- * tot_height = height + vfrontporch + vsync + vbackporch +
- * il_vfrontporch + il_vsync + il_vbackporch
- *
- * The active height of each field is height / 2.
- */
- struct v4l2_bt_timings {
- __u32 width;
- __u32 height;
- __u32 interlaced;
- __u32 polarities;
- __u64 pixelclock;
- __u32 hfrontporch;
- __u32 hsync;
- __u32 hbackporch;
- __u32 vfrontporch;
- __u32 vsync;
- __u32 vbackporch;
- __u32 il_vfrontporch;
- __u32 il_vsync;
- __u32 il_vbackporch;
- __u32 standards;
- __u32 flags;
- __u32 reserved[14];
- } __attribute__ ((packed));
-
- /* Interlaced or progressive format */
- #define V4L2_DV_PROGRESSIVE 0
- #define V4L2_DV_INTERLACED 1
-
- /* Polarities. If bit is not set, it is assumed to be negative polarity */
- #define V4L2_DV_VSYNC_POS_POL 0x00000001
- #define V4L2_DV_HSYNC_POS_POL 0x00000002
-
- /* Timings standards */
- #define V4L2_DV_BT_STD_CEA861 (1 << 0) /* CEA-861 Digital TV Profile */
- #define V4L2_DV_BT_STD_DMT (1 << 1) /* VESA Discrete Monitor Timings */
- #define V4L2_DV_BT_STD_CVT (1 << 2) /* VESA Coordinated Video Timings */
- #define V4L2_DV_BT_STD_GTF (1 << 3) /* VESA Generalized Timings Formula */
-
- /* Flags */
-
- /* CVT/GTF specific: timing uses reduced blanking (CVT) or the 'Secondary
- GTF' curve (GTF). In both cases the horizontal and/or vertical blanking
- intervals are reduced, allowing a higher resolution over the same
- bandwidth. This is a read-only flag. */
- #define V4L2_DV_FL_REDUCED_BLANKING (1 << 0)
- /* CEA-861 specific: set for CEA-861 formats with a framerate of a multiple
- of six. These formats can be optionally played at 1 / 1.001 speed.
- This is a read-only flag. */
- #define V4L2_DV_FL_CAN_REDUCE_FPS (1 << 1)
- /* CEA-861 specific: only valid for video transmitters, the flag is cleared
- by receivers.
- If the framerate of the format is a multiple of six, then the pixelclock
- used to set up the transmitter is divided by 1.001 to make it compatible
- with 60 Hz based standards such as NTSC and PAL-M that use a framerate of
- 29.97 Hz. Otherwise this flag is cleared. If the transmitter can't generate
- such frequencies, then the flag will also be cleared. */
- #define V4L2_DV_FL_REDUCED_FPS (1 << 2)
- /* Specific to interlaced formats: if set, then field 1 is really one half-line
- longer and field 2 is really one half-line shorter, so each field has
- exactly the same number of half-lines. Whether half-lines can be detected
- or used depends on the hardware. */
- #define V4L2_DV_FL_HALF_LINE (1 << 3)
- /* If set, then this is a Consumer Electronics (CE) video format. Such formats
- * differ from other formats (commonly called IT formats) in that if RGB
- * encoding is used then by default the RGB values use limited range (i.e.ie;
- * use the range 16-235) as opposed to 0-255. All formats defined in CEA-861
- * except for the 640x480 format are CE formats. */
- #define V4L2_DV_FL_IS_CE_VIDEO (1 << 4)
-
- /* A few useful defines to calculate the total blanking and frame sizes */
- #define V4L2_DV_BT_BLANKING_WIDTH(bt)
- ((bt)->hfrontporch + (bt)->hsync + (bt)->hbackporch)
- #define V4L2_DV_BT_FRAME_WIDTH(bt)
- ((bt)->width + V4L2_DV_BT_BLANKING_WIDTH(bt))
- #define V4L2_DV_BT_BLANKING_HEIGHT(bt)
- ((bt)->vfrontporch + (bt)->vsync + (bt)->vbackporch + \\
- (bt)->il_vfrontporch + (bt)->il_vsync + (bt)->il_vbackporch)
- #define V4L2_DV_BT_FRAME_HEIGHT(bt)
- ((bt)->height + V4L2_DV_BT_BLANKING_HEIGHT(bt))
-
- /** struct v4l2_dv_timings - DV timings
- * @type: the type of the timings
- * @bt: BT656/1120 timings
- */
- struct v4l2_dv_timings {
- __u32 type;
- union {
- struct v4l2_bt_timings bt;
- __u32 reserved[32];
- };
- } __attribute__ ((packed));
-
- /* Values for the type field */
- #define V4L2_DV_BT_656_1120 0 /* BT.656/1120 timing type */
-
-
- /** struct v4l2_enum_dv_timings - DV timings enumeration
- * @index: enumeration index
- * @pad: the pad number for which to enumerate timings (used with
- * v4l-subdev nodes only)
- * @reserved: must be zeroed
- * @timings: the timings for the given index
- */
- struct v4l2_enum_dv_timings {
- __u32 index;
- __u32 pad;
- __u32 reserved[2];
- struct v4l2_dv_timings timings;
- };
-
- /** struct v4l2_bt_timings_cap - BT.656/BT.1120 timing capabilities
- * @min_width: width in pixels
- * @max_width: width in pixels
- * @min_height: height in lines
- * @max_height: height in lines
- * @min_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
- * @max_pixelclock: Pixel clock in HZ. Ex. 74.25MHz->74250000
- * @standards: Supported standards
- * @capabilities: Supported capabilities
- * @reserved: Must be zeroed
- */
- struct v4l2_bt_timings_cap {
- __u32 min_width;
- __u32 max_width;
- __u32 min_height;
- __u32 max_height;
- __u64 min_pixelclock;
- __u64 max_pixelclock;
- __u32 standards;
- __u32 capabilities;
- __u32 reserved[16];
- } __attribute__ ((packed));
-
- /* Supports interlaced formats */
- #define V4L2_DV_BT_CAP_INTERLACED (1 << 0)
- /* Supports progressive formats */
- #define V4L2_DV_BT_CAP_PROGRESSIVE (1 << 1)
- /* Supports CVT/GTF reduced blanking */
- #define V4L2_DV_BT_CAP_REDUCED_BLANKING (1 << 2)
- /* Supports custom formats */
- #define V4L2_DV_BT_CAP_CUSTOM (1 << 3)
-
- /** struct v4l2_dv_timings_cap - DV timings capabilities
- * @type: the type of the timings (same as in struct v4l2_dv_timings)
- * @pad: the pad number for which to query capabilities (used with
- * v4l-subdev nodes only)
- * @bt: the BT656/1120 timings capabilities
- */
- struct v4l2_dv_timings_cap {
- __u32 type;
- __u32 pad;
- __u32 reserved[2];
- union {
- struct v4l2_bt_timings_cap bt;
- __u32 raw_data[32];
- };
- };
-
-
- /*
- * V I D E O I N P U T S
- */
- struct v4l2_input {
- __u32 index; /* Which input */
- __u8 name[32]; /* Label */
- __u32 type; /* Type of input */
- __u32 audioset; /* Associated audios (bitfield) */
- __u32 tuner; /* enum v4l2_tuner_type */
- v4l2_std_id std;
- __u32 status;
- __u32 capabilities;
- __u32 reserved[3];
- };
-
- /* Values for the 'type' field */
- #define V4L2_INPUT_TYPE_TUNER 1
- #define V4L2_INPUT_TYPE_CAMERA 2
-
- /* field 'status' - general */
- #define V4L2_IN_ST_NO_POWER 0x00000001 /* Attached device is off */
- #define V4L2_IN_ST_NO_SIGNAL 0x00000002
- #define V4L2_IN_ST_NO_COLOR 0x00000004
-
- /* field 'status' - sensor orientation */
- /* If sensor is mounted upside down set both bits */
- #define V4L2_IN_ST_HFLIP 0x00000010 /* Frames are flipped horizontally */
- #define V4L2_IN_ST_VFLIP 0x00000020 /* Frames are flipped vertically */
-
- /* field 'status' - analog */
- #define V4L2_IN_ST_NO_H_LOCK 0x00000100 /* No horizontal sync lock */
- #define V4L2_IN_ST_COLOR_KILL 0x00000200 /* Color killer is active */
-
- /* field 'status' - digital */
- #define V4L2_IN_ST_NO_SYNC 0x00010000 /* No synchronization lock */
- #define V4L2_IN_ST_NO_EQU 0x00020000 /* No equalizer lock */
- #define V4L2_IN_ST_NO_CARRIER 0x00040000 /* Carrier recovery failed */
-
- /* field 'status' - VCR and set-top box */
- #define V4L2_IN_ST_MACROVISION 0x01000000 /* Macrovision detected */
- #define V4L2_IN_ST_NO_ACCESS 0x02000000 /* Conditional access denied */
- #define V4L2_IN_ST_VTR 0x04000000 /* VTR time constant */
-
- /* capabilities flags */
- #define V4L2_IN_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
- #define V4L2_IN_CAP_CUSTOM_TIMINGS V4L2_IN_CAP_DV_TIMINGS /* For compatibility */
- #define V4L2_IN_CAP_STD 0x00000004 /* Supports S_STD */
- #define V4L2_IN_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
-
- /*
- * V I D E O O U T P U T S
- */
- struct v4l2_output {
- __u32 index; /* Which output */
- __u8 name[32]; /* Label */
- __u32 type; /* Type of output */
- __u32 audioset; /* Associated audios (bitfield) */
- __u32 modulator; /* Associated modulator */
- v4l2_std_id std;
- __u32 capabilities;
- __u32 reserved[3];
- };
- /* Values for the 'type' field */
- #define V4L2_OUTPUT_TYPE_MODULATOR 1
- #define V4L2_OUTPUT_TYPE_ANALOG 2
- #define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY 3
-
- /* capabilities flags */
- #define V4L2_OUT_CAP_DV_TIMINGS 0x00000002 /* Supports S_DV_TIMINGS */
- #define V4L2_OUT_CAP_CUSTOM_TIMINGS V4L2_OUT_CAP_DV_TIMINGS /* For compatibility */
- #define V4L2_OUT_CAP_STD 0x00000004 /* Supports S_STD */
- #define V4L2_OUT_CAP_NATIVE_SIZE 0x00000008 /* Supports setting native size */
-
- /*
- * C O N T R O L S
- */
- struct v4l2_control {
- __u32 id;
- __s32 value;
- };
-
- struct v4l2_ext_control {
- __u32 id;
- __u32 size;
- __u32 reserved2[1];
- union {
- __s32 value;
- __s64 value64;
- char __user *string;
- __u8 __user *p_u8;
- __u16 __user *p_u16;
- __u32 __user *p_u32;
- void __user *ptr;
- };
- } __attribute__ ((packed));
-
- struct v4l2_ext_controls {
- union {
- #ifndef __KERNEL__
- __u32 ctrl_class;
- #endif
- __u32 which;
- };
- __u32 count;
- __u32 error_idx;
- __u32 reserved[2];
- struct v4l2_ext_control *controls;
- };
-
- #define V4L2_CTRL_ID_MASK (0x0fffffff)
- #ifndef __KERNEL__
- #define V4L2_CTRL_ID2CLASS(id) ((id) & 0x0fff0000UL)
- #endif
- #define V4L2_CTRL_ID2WHICH(id) ((id) & 0x0fff0000UL)
- #define V4L2_CTRL_DRIVER_PRIV(id) (((id) & 0xffff) >= 0x1000)
- #define V4L2_CTRL_MAX_DIMS (4)
- #define V4L2_CTRL_WHICH_CUR_VAL 0
- #define V4L2_CTRL_WHICH_DEF_VAL 0x0f000000
-
- enum v4l2_ctrl_type {
- V4L2_CTRL_TYPE_INTEGER = 1,
- V4L2_CTRL_TYPE_BOOLEAN = 2,
- V4L2_CTRL_TYPE_MENU = 3,
- V4L2_CTRL_TYPE_BUTTON = 4,
- V4L2_CTRL_TYPE_INTEGER64 = 5,
- V4L2_CTRL_TYPE_CTRL_CLASS = 6,
- V4L2_CTRL_TYPE_STRING = 7,
- V4L2_CTRL_TYPE_BITMASK = 8,
- V4L2_CTRL_TYPE_INTEGER_MENU = 9,
-
- /* Compound types are >= 0x0100 */
- V4L2_CTRL_COMPOUND_TYPES = 0x0100,
- V4L2_CTRL_TYPE_U8 = 0x0100,
- V4L2_CTRL_TYPE_U16 = 0x0101,
- V4L2_CTRL_TYPE_U32 = 0x0102,
- };
-
- /* Used in the VIDIOC_QUERYCTRL ioctl for querying controls */
- struct v4l2_queryctrl {
- __u32 id;
- __u32 type; /* enum v4l2_ctrl_type */
- __u8 name[32]; /* Whatever */
- __s32 minimum; /* Note signedness */
- __s32 maximum;
- __s32 step;
- __s32 default_value;
- __u32 flags;
- __u32 reserved[2];
- };
-
- /* Used in the VIDIOC_QUERY_EXT_CTRL ioctl for querying extended controls */
- struct v4l2_query_ext_ctrl {
- __u32 id;
- __u32 type;
- char name[32];
- __s64 minimum;
- __s64 maximum;
- __u64 step;
- __s64 default_value;
- __u32 flags;
- __u32 elem_size;
- __u32 elems;
- __u32 nr_of_dims;
- __u32 dims[V4L2_CTRL_MAX_DIMS];
- __u32 reserved[32];
- };
-
- /* Used in the VIDIOC_QUERYMENU ioctl for querying menu items */
- struct v4l2_querymenu {
- __u32 id;
- __u32 index;
- union {
- __u8 name[32]; /* Whatever */
- __s64 value;
- };
- __u32 reserved;
- } __attribute__ ((packed));
-
- /* Control flags */
- #define V4L2_CTRL_FLAG_DISABLED 0x0001
- #define V4L2_CTRL_FLAG_GRABBED 0x0002
- #define V4L2_CTRL_FLAG_READ_ONLY 0x0004
- #define V4L2_CTRL_FLAG_UPDATE 0x0008
- #define V4L2_CTRL_FLAG_INACTIVE 0x0010
- #define V4L2_CTRL_FLAG_SLIDER 0x0020
- #define V4L2_CTRL_FLAG_WRITE_ONLY 0x0040
- #define V4L2_CTRL_FLAG_VOLATILE 0x0080
- #define V4L2_CTRL_FLAG_HAS_PAYLOAD 0x0100
- #define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE 0x0200
-
- /* Query flags, to be ORed with the control ID */
- #define V4L2_CTRL_FLAG_NEXT_CTRL 0x80000000
- #define V4L2_CTRL_FLAG_NEXT_COMPOUND 0x40000000
-
- /* User-class control IDs defined by V4L2 */
- #define V4L2_CID_MAX_CTRLS 1024
- /* IDs reserved for driver specific controls */
- #define V4L2_CID_PRIVATE_BASE 0x08000000
-
-
- /*
- * T U N I N G
- */
- struct v4l2_tuner {
- __u32 index;
- __u8 name[32];
- __u32 type; /* enum v4l2_tuner_type */
- __u32 capability;
- __u32 rangelow;
- __u32 rangehigh;
- __u32 rxsubchans;
- __u32 audmode;
- __s32 signal;
- __s32 afc;
- __u32 reserved[4];
- };
-
- struct v4l2_modulator {
- __u32 index;
- __u8 name[32];
- __u32 capability;
- __u32 rangelow;
- __u32 rangehigh;
- __u32 txsubchans;
- __u32 type; /* enum v4l2_tuner_type */
- __u32 reserved[3];
- };
-
- /* Flags for the 'capability' field */
- #define V4L2_TUNER_CAP_LOW 0x0001
- #define V4L2_TUNER_CAP_NORM 0x0002
- #define V4L2_TUNER_CAP_HWSEEK_BOUNDED 0x0004
- #define V4L2_TUNER_CAP_HWSEEK_WRAP 0x0008
- #define V4L2_TUNER_CAP_STEREO 0x0010
- #define V4L2_TUNER_CAP_LANG2 0x0020
- #define V4L2_TUNER_CAP_SAP 0x0020
- #define V4L2_TUNER_CAP_LANG1 0x0040
- #define V4L2_TUNER_CAP_RDS 0x0080
- #define V4L2_TUNER_CAP_RDS_BLOCK_IO 0x0100
- #define V4L2_TUNER_CAP_RDS_CONTROLS 0x0200
- #define V4L2_TUNER_CAP_FREQ_BANDS 0x0400
- #define V4L2_TUNER_CAP_HWSEEK_PROG_LIM 0x0800
- #define V4L2_TUNER_CAP_1HZ 0x1000
-
- /* Flags for the 'rxsubchans' field */
- #define V4L2_TUNER_SUB_MONO 0x0001
- #define V4L2_TUNER_SUB_STEREO 0x0002
- #define V4L2_TUNER_SUB_LANG2 0x0004
- #define V4L2_TUNER_SUB_SAP 0x0004
- #define V4L2_TUNER_SUB_LANG1 0x0008
- #define V4L2_TUNER_SUB_RDS 0x0010
-
- /* Values for the 'audmode' field */
- #define V4L2_TUNER_MODE_MONO 0x0000
- #define V4L2_TUNER_MODE_STEREO 0x0001
- #define V4L2_TUNER_MODE_LANG2 0x0002
- #define V4L2_TUNER_MODE_SAP 0x0002
- #define V4L2_TUNER_MODE_LANG1 0x0003
- #define V4L2_TUNER_MODE_LANG1_LANG2 0x0004
-
- struct v4l2_frequency {
- __u32 tuner;
- __u32 type; /* enum v4l2_tuner_type */
- __u32 frequency;
- __u32 reserved[8];
- };
-
- #define V4L2_BAND_MODULATION_VSB (1 << 1)
- #define V4L2_BAND_MODULATION_FM (1 << 2)
- #define V4L2_BAND_MODULATION_AM (1 << 3)
-
- struct v4l2_frequency_band {
- __u32 tuner;
- __u32 type; /* enum v4l2_tuner_type */
- __u32 index;
- __u32 capability;
- __u32 rangelow;
- __u32 rangehigh;
- __u32 modulation;
- __u32 reserved[9];
- };
-
- struct v4l2_hw_freq_seek {
- __u32 tuner;
- __u32 type; /* enum v4l2_tuner_type */
- __u32 seek_upward;
- __u32 wrap_around;
- __u32 spacing;
- __u32 rangelow;
- __u32 rangehigh;
- __u32 reserved[5];
- };
-
- /*
- * R D S
- */
-
- struct v4l2_rds_data {
- __u8 lsb;
- __u8 msb;
- __u8 block;
- } __attribute__ ((packed));
-
- #define V4L2_RDS_BLOCK_MSK 0x7
- #define V4L2_RDS_BLOCK_A 0
- #define V4L2_RDS_BLOCK_B 1
- #define V4L2_RDS_BLOCK_C 2
- #define V4L2_RDS_BLOCK_D 3
- #define V4L2_RDS_BLOCK_C_ALT 4
- #define V4L2_RDS_BLOCK_INVALID 7
-
- #define V4L2_RDS_BLOCK_CORRECTED 0x40
- #define V4L2_RDS_BLOCK_ERROR 0x80
-
- /*
- * A U D I O
- */
- struct v4l2_audio {
- __u32 index;
- __u8 name[32];
- __u32 capability;
- __u32 mode;
- __u32 reserved[2];
- };
-
- /* Flags for the 'capability' field */
- #define V4L2_AUDCAP_STEREO 0x00001
- #define V4L2_AUDCAP_AVL 0x00002
-
- /* Flags for the 'mode' field */
- #define V4L2_AUDMODE_AVL 0x00001
-
- struct v4l2_audioout {
- __u32 index;
- __u8 name[32];
- __u32 capability;
- __u32 mode;
- __u32 reserved[2];
- };
-
- /*
- * M P E G S E R V I C E S
- */
- #if 1
- #define V4L2_ENC_IDX_FRAME_I (0)
- #define V4L2_ENC_IDX_FRAME_P (1)
- #define V4L2_ENC_IDX_FRAME_B (2)
- #define V4L2_ENC_IDX_FRAME_MASK (0xf)
-
- struct v4l2_enc_idx_entry {
- __u64 offset;
- __u64 pts;
- __u32 length;
- __u32 flags;
- __u32 reserved[2];
- };
-
- #define V4L2_ENC_IDX_ENTRIES (64)
- struct v4l2_enc_idx {
- __u32 entries;
- __u32 entries_cap;
- __u32 reserved[4];
- struct v4l2_enc_idx_entry entry[V4L2_ENC_IDX_ENTRIES];
- };
-
-
- #define V4L2_ENC_CMD_START (0)
- #define V4L2_ENC_CMD_STOP (1)
- #define V4L2_ENC_CMD_PAUSE (2)
- #define V4L2_ENC_CMD_RESUME (3)
-
- /* Flags for V4L2_ENC_CMD_STOP */
- #define V4L2_ENC_CMD_STOP_AT_GOP_END (1 << 0)
-
- struct v4l2_encoder_cmd {
- __u32 cmd;
- __u32 flags;
- union {
- struct {
- __u32 data[8];
- } raw;
- };
- };
-
- /* Decoder commands */
- #define V4L2_DEC_CMD_START (0)
- #define V4L2_DEC_CMD_STOP (1)
- #define V4L2_DEC_CMD_PAUSE (2)
- #define V4L2_DEC_CMD_RESUME (3)
-
- /* Flags for V4L2_DEC_CMD_START */
- #define V4L2_DEC_CMD_START_MUTE_AUDIO (1 << 0)
-
- /* Flags for V4L2_DEC_CMD_PAUSE */
- #define V4L2_DEC_CMD_PAUSE_TO_BLACK (1 << 0)
-
- /* Flags for V4L2_DEC_CMD_STOP */
- #define V4L2_DEC_CMD_STOP_TO_BLACK (1 << 0)
- #define V4L2_DEC_CMD_STOP_IMMEDIATELY (1 << 1)
-
- /* Play format requirements (returned by the driver): */
-
- /* The decoder has no special format requirements */
- #define V4L2_DEC_START_FMT_NONE (0)
- /* The decoder requires full GOPs */
- #define V4L2_DEC_START_FMT_GOP (1)
-
- /* The structure must be zeroed before use by the application
- This ensures it can be extended safely in the future. */
- struct v4l2_decoder_cmd {
- __u32 cmd;
- __u32 flags;
- union {
- struct {
- __u64 pts;
- } stop;
-
- struct {
- /* 0 or 1000 specifies normal speed,
- 1 specifies forward single stepping,
- -1 specifies backward single stepping,
- >1: playback at speed/1000 of the normal speed,
- <-1: reverse playback at (-speed/1000) of the normal speed. */
- __s32 speed;
- __u32 format;
- } start;
-
- struct {
- __u32 data[16];
- } raw;
- };
- };
- #endif
-
-
- /*
- * D A T A S E R V I C E S ( V B I )
- *
- * Data services API by Michael Schimek
- */
-
- /* Raw VBI */
- struct v4l2_vbi_format {
- __u32 sampling_rate; /* in 1 Hz */
- __u32 offset;
- __u32 samples_per_line;
- __u32 sample_format; /* V4L2_PIX_FMT_* */
- __s32 start[2];
- __u32 count[2];
- __u32 flags; /* V4L2_VBI_* */
- __u32 reserved[2]; /* must be zero */
- };
-
- /* VBI flags */
- #define V4L2_VBI_UNSYNC (1 << 0)
- #define V4L2_VBI_INTERLACED (1 << 1)
-
- /* ITU-R start lines for each field */
- #define V4L2_VBI_ITU_525_F1_START (1)
- #define V4L2_VBI_ITU_525_F2_START (264)
- #define V4L2_VBI_ITU_625_F1_START (1)
- #define V4L2_VBI_ITU_625_F2_START (314)
-
- /* Sliced VBI
- *
- * This implements is a proposal V4L2 API to allow SLICED VBI
- * required for some hardware encoders. It should change without
- * notice in the definitive implementation.
- */
-
- struct v4l2_sliced_vbi_format {
- __u16 service_set;
- /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
- service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
- (equals frame lines 313-336 for 625 line video
- standards, 263-286 for 525 line standards) */
- __u16 service_lines[2][24];
- __u32 io_size;
- __u32 reserved[2]; /* must be zero */
- };
-
- /* Teletext World System Teletext
- (WST), defined on ITU-R BT.653-2 */
- #define V4L2_SLICED_TELETEXT_B (0x0001)
- /* Video Program System, defined on ETS 300 231*/
- #define V4L2_SLICED_VPS (0x0400)
- /* Closed Caption, defined on EIA-608 */
- #define V4L2_SLICED_CAPTION_525 (0x1000)
- /* Wide Screen System, defined on ITU-R BT1119.1 */
- #define V4L2_SLICED_WSS_625 (0x4000)
-
- #define V4L2_SLICED_VBI_525 (V4L2_SLICED_CAPTION_525)
- #define V4L2_SLICED_VBI_625 (V4L2_SLICED_TELETEXT_B | V4L2_SLICED_VPS | V4L2_SLICED_WSS_625)
-
- struct v4l2_sliced_vbi_cap {
- __u16 service_set;
- /* service_lines[0][...] specifies lines 0-23 (1-23 used) of the first field
- service_lines[1][...] specifies lines 0-23 (1-23 used) of the second field
- (equals frame lines 313-336 for 625 line video
- standards, 263-286 for 525 line standards) */
- __u16 service_lines[2][24];
- __u32 type; /* enum v4l2_buf_type */
- __u32 reserved[3]; /* must be 0 */
- };
-
- struct v4l2_sliced_vbi_data {
- __u32 id;
- __u32 field; /* 0: first field, 1: second field */
- __u32 line; /* 1-23 */
- __u32 reserved; /* must be 0 */
- __u8 data[48];
- };
-
- /*
- * Sliced VBI data inserted into MPEG Streams
- */
-
- /*
- * V4L2_MPEG_STREAM_VBI_FMT_IVTV:
- *
- * Structure of payload contained in an MPEG 2 Private Stream 1 PES Packet in an
- * MPEG-2 Program Pack that contains V4L2_MPEG_STREAM_VBI_FMT_IVTV Sliced VBI
- * data
- *
- * Note, the MPEG-2 Program Pack and Private Stream 1 PES packet header
- * definitions are not included here. See the MPEG-2 specifications for details
- * on these headers.
- */
-
- /* Line type IDs */
- #define V4L2_MPEG_VBI_IVTV_TELETEXT_B (1)
- #define V4L2_MPEG_VBI_IVTV_CAPTION_525 (4)
- #define V4L2_MPEG_VBI_IVTV_WSS_625 (5)
- #define V4L2_MPEG_VBI_IVTV_VPS (7)
-
- struct v4l2_mpeg_vbi_itv0_line {
- __u8 id; /* One of V4L2_MPEG_VBI_IVTV_* above */
- __u8 data[42]; /* Sliced VBI data for the line */
- } __attribute__ ((packed));
-
- struct v4l2_mpeg_vbi_itv0 {
- __le32 linemask[2]; /* Bitmasks of VBI service lines present */
- struct v4l2_mpeg_vbi_itv0_line line[35];
- } __attribute__ ((packed));
-
- struct v4l2_mpeg_vbi_ITV0 {
- struct v4l2_mpeg_vbi_itv0_line line[36];
- } __attribute__ ((packed));
-
- #define V4L2_MPEG_VBI_IVTV_MAGIC0 "itv0"
- #define V4L2_MPEG_VBI_IVTV_MAGIC1 "ITV0"
-
- struct v4l2_mpeg_vbi_fmt_ivtv {
- __u8 magic[4];
- union {
- struct v4l2_mpeg_vbi_itv0 itv0;
- struct v4l2_mpeg_vbi_ITV0 ITV0;
- };
- } __attribute__ ((packed));
-
- /*
- * A G G R E G A T E S T R U C T U R E S
- */
-
- /**
- * struct v4l2_plane_pix_format - additional, per-plane format definition
- * @sizeimage: maximum size in bytes required for data, for which
- * this plane will be used
- * @bytesperline: distance in bytes between the leftmost pixels in two
- * adjacent lines
- */
- struct v4l2_plane_pix_format {
- __u32 sizeimage;
- __u32 bytesperline;
- __u16 reserved[6];
- } __attribute__ ((packed));
-
- /**
- * struct v4l2_pix_format_mplane - multiplanar format definition
- * @width: image width in pixels
- * @height: image height in pixels
- * @pixelformat: little endian four character code (fourcc)
- * @field: enum v4l2_field; field order (for interlaced video)
- * @colorspace: enum v4l2_colorspace; supplemental to pixelformat
- * @plane_fmt: per-plane information
- * @num_planes: number of planes for this format
- * @flags: format flags (V4L2_PIX_FMT_FLAG_*)
- * @ycbcr_enc: enum v4l2_ycbcr_encoding, Y'CbCr encoding
- * @quantization: enum v4l2_quantization, colorspace quantization
- * @xfer_func: enum v4l2_xfer_func, colorspace transfer function
- */
- struct v4l2_pix_format_mplane {
- __u32 width;
- __u32 height;
- __u32 pixelformat;
- __u32 field;
- __u32 colorspace;
-
- struct v4l2_plane_pix_format plane_fmt[VIDEO_MAX_PLANES];
- __u8 num_planes;
- __u8 flags;
- __u8 ycbcr_enc;
- __u8 quantization;
- __u8 xfer_func;
- __u8 reserved[7];
- } __attribute__ ((packed));
-
- /**
- * struct v4l2_sdr_format - SDR format definition
- * @pixelformat: little endian four character code (fourcc)
- * @buffersize: maximum size in bytes required for data
- */
- struct v4l2_sdr_format {
- __u32 pixelformat;
- __u32 buffersize;
- __u8 reserved[24];
- } __attribute__ ((packed));
-
- /**
- * struct v4l2_format - stream data format
- * @type: enum v4l2_buf_type; type of the data stream
- * @pix: definition of an image format
- * @pix_mp: definition of a multiplanar image format
- * @win: definition of an overlaid image
- * @vbi: raw VBI capture or output parameters
- * @sliced: sliced VBI capture or output parameters
- * @raw_data: placeholder for future extensions and custom formats
- */
- struct v4l2_format {
- __u32 type;
- union {
- struct v4l2_pix_format pix; /* V4L2_BUF_TYPE_VIDEO_CAPTURE */
- struct v4l2_pix_format_mplane pix_mp; /* V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE */
- struct v4l2_window win; /* V4L2_BUF_TYPE_VIDEO_OVERLAY */
- struct v4l2_vbi_format vbi; /* V4L2_BUF_TYPE_VBI_CAPTURE */
- struct v4l2_sliced_vbi_format sliced; /* V4L2_BUF_TYPE_SLICED_VBI_CAPTURE */
- struct v4l2_sdr_format sdr; /* V4L2_BUF_TYPE_SDR_CAPTURE */
- __u8 raw_data[200]; /* user-defined */
- } fmt;
- };
-
- /* Stream type-dependent parameters
- */
- struct v4l2_streamparm {
- __u32 type; /* enum v4l2_buf_type */
- union {
- struct v4l2_captureparm capture;
- struct v4l2_outputparm output;
- __u8 raw_data[200]; /* user-defined */
- } parm;
- };
-
- /*
- * E V E N T S
- */
-
- #define V4L2_EVENT_ALL 0
- #define V4L2_EVENT_VSYNC 1
- #define V4L2_EVENT_EOS 2
- #define V4L2_EVENT_CTRL 3
- #define V4L2_EVENT_FRAME_SYNC 4
- #define V4L2_EVENT_SOURCE_CHANGE 5
- #define V4L2_EVENT_MOTION_DET 6
- #define V4L2_EVENT_PRIVATE_START 0x08000000
-
- /* Payload for V4L2_EVENT_VSYNC */
- struct v4l2_event_vsync {
- /* Can be V4L2_FIELD_ANY, _NONE, _TOP or _BOTTOM */
- __u8 field;
- } __attribute__ ((packed));
-
- /* Payload for V4L2_EVENT_CTRL */
- #define V4L2_EVENT_CTRL_CH_VALUE (1 << 0)
- #define V4L2_EVENT_CTRL_CH_FLAGS (1 << 1)
- #define V4L2_EVENT_CTRL_CH_RANGE (1 << 2)
-
- struct v4l2_event_ctrl {
- __u32 changes;
- __u32 type;
- union {
- __s32 value;
- __s64 value64;
- };
- __u32 flags;
- __s32 minimum;
- __s32 maximum;
- __s32 step;
- __s32 default_value;
- };
-
- struct v4l2_event_frame_sync {
- __u32 frame_sequence;
- };
-
- #define V4L2_EVENT_SRC_CH_RESOLUTION (1 << 0)
-
- struct v4l2_event_src_change {
- __u32 changes;
- };
-
- #define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ (1 << 0)
-
- /**
- * struct v4l2_event_motion_det - motion detection event
- * @flags: if V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ is set, then the
- * frame_sequence field is valid.
- * @frame_sequence: the frame sequence number associated with this event.
- * @region_mask: which regions detected motion.
- */
- struct v4l2_event_motion_det {
- __u32 flags;
- __u32 frame_sequence;
- __u32 region_mask;
- };
-
- struct v4l2_event {
- __u32 type;
- union {
- struct v4l2_event_vsync vsync;
- struct v4l2_event_ctrl ctrl;
- struct v4l2_event_frame_sync frame_sync;
- struct v4l2_event_src_change src_change;
- struct v4l2_event_motion_det motion_det;
- __u8 data[64];
- } u;
- __u32 pending;
- __u32 sequence;
- struct timespec timestamp;
- __u32 id;
- __u32 reserved[8];
- };
-
- #define V4L2_EVENT_SUB_FL_SEND_INITIAL (1 << 0)
- #define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK (1 << 1)
-
- struct v4l2_event_subscription {
- __u32 type;
- __u32 id;
- __u32 flags;
- __u32 reserved[5];
- };
-
- /*
- * A D V A N C E D D E B U G G I N G
- *
- * NOTE: EXPERIMENTAL API, NEVER RELY ON THIS IN APPLICATIONS!
- * FOR DEBUGGING, TESTING AND INTERNAL USE ONLY!
- */
-
- /* VIDIOC_DBG_G_REGISTER and VIDIOC_DBG_S_REGISTER */
-
- #define V4L2_CHIP_MATCH_BRIDGE 0 /* Match against chip ID on the bridge (0 for the bridge) */
- #define V4L2_CHIP_MATCH_SUBDEV 4 /* Match against subdev index */
-
- /* The following four defines are no longer in use */
- #define V4L2_CHIP_MATCH_HOST V4L2_CHIP_MATCH_BRIDGE
- #define V4L2_CHIP_MATCH_I2C_DRIVER 1 /* Match against I2C driver name */
- #define V4L2_CHIP_MATCH_I2C_ADDR 2 /* Match against I2C 7-bit address */
- #define V4L2_CHIP_MATCH_AC97 3 /* Match against ancillary AC97 chip */
-
- struct v4l2_dbg_match {
- __u32 type; /* Match type */
- union { /* Match this chip, meaning determined by type */
- __u32 addr;
- char name[32];
- };
- } __attribute__ ((packed));
-
- struct v4l2_dbg_register {
- struct v4l2_dbg_match match;
- __u32 size; /* register size in bytes */
- __u64 reg;
- __u64 val;
- } __attribute__ ((packed));
-
- #define V4L2_CHIP_FL_READABLE (1 << 0)
- #define V4L2_CHIP_FL_WRITABLE (1 << 1)
-
- /* VIDIOC_DBG_G_CHIP_INFO */
- struct v4l2_dbg_chip_info {
- struct v4l2_dbg_match match;
- char name[32];
- __u32 flags;
- __u32 reserved[32];
- } __attribute__ ((packed));
-
- /**
- * struct v4l2_create_buffers - VIDIOC_CREATE_BUFS argument
- * @index: on return, index of the first created buffer
- * @count: entry: number of requested buffers,
- * return: number of created buffers
- * @memory: enum v4l2_memory; buffer memory type
- * @format: frame format, for which buffers are requested
- * @reserved: future extensions
- */
- struct v4l2_create_buffers {
- __u32 index;
- __u32 count;
- __u32 memory;
- struct v4l2_format format;
- __u32 reserved[8];
- };
-
- /*
- * I O C T L C O D E S F O R V I D E O D E V I C E S
- *
- */
- #define VIDIOC_QUERYCAP _IOR('V', 0, struct v4l2_capability)
- #define VIDIOC_RESERVED _IO('V', 1)
- #define VIDIOC_ENUM_FMT _IOWR('V', 2, struct v4l2_fmtdesc)
- #define VIDIOC_G_FMT _IOWR('V', 4, struct v4l2_format)
- #define VIDIOC_S_FMT _IOWR('V', 5, struct v4l2_format)
- #define VIDIOC_REQBUFS _IOWR('V', 8, struct v4l2_requestbuffers)
- #define VIDIOC_QUERYBUF _IOWR('V', 9, struct v4l2_buffer)
- #define VIDIOC_G_FBUF _IOR('V', 10, struct v4l2_framebuffer)
- #define VIDIOC_S_FBUF _IOW('V', 11, struct v4l2_framebuffer)
- #define VIDIOC_OVERLAY _IOW('V', 14, int)
- #define VIDIOC_QBUF _IOWR('V', 15, struct v4l2_buffer)
- #define VIDIOC_EXPBUF _IOWR('V', 16, struct v4l2_exportbuffer)
- #define VIDIOC_DQBUF _IOWR('V', 17, struct v4l2_buffer)
- #define VIDIOC_STREAMON _IOW('V', 18, int)
- #define VIDIOC_STREAMOFF _IOW('V', 19, int)
- #define VIDIOC_G_PARM _IOWR('V', 21, struct v4l2_streamparm)
- #define VIDIOC_S_PARM _IOWR('V', 22, struct v4l2_streamparm)
- #define VIDIOC_G_STD _IOR('V', 23, v4l2_std_id)
- #define VIDIOC_S_STD _IOW('V', 24, v4l2_std_id)
- #define VIDIOC_ENUMSTD _IOWR('V', 25, struct v4l2_standard)
- #define VIDIOC_ENUMINPUT _IOWR('V', 26, struct v4l2_input)
- #define VIDIOC_G_CTRL _IOWR('V', 27, struct v4l2_control)
- #define VIDIOC_S_CTRL _IOWR('V', 28, struct v4l2_control)
- #define VIDIOC_G_TUNER _IOWR('V', 29, struct v4l2_tuner)
- #define VIDIOC_S_TUNER _IOW('V', 30, struct v4l2_tuner)
- #define VIDIOC_G_AUDIO _IOR('V', 33, struct v4l2_audio)
- #define VIDIOC_S_AUDIO _IOW('V', 34, struct v4l2_audio)
- #define VIDIOC_QUERYCTRL _IOWR('V', 36, struct v4l2_queryctrl)
- #define VIDIOC_QUERYMENU _IOWR('V', 37, struct v4l2_querymenu)
- #define VIDIOC_G_INPUT _IOR('V', 38, int)
- #define VIDIOC_S_INPUT _IOWR('V', 39, int)
- #define VIDIOC_G_EDID _IOWR('V', 40, struct v4l2_edid)
- #define VIDIOC_S_EDID _IOWR('V', 41, struct v4l2_edid)
- #define VIDIOC_G_OUTPUT _IOR('V', 46, int)
- #define VIDIOC_S_OUTPUT _IOWR('V', 47, int)
- #define VIDIOC_ENUMOUTPUT _IOWR('V', 48, struct v4l2_output)
- #define VIDIOC_G_AUDOUT _IOR('V', 49, struct v4l2_audioout)
- #define VIDIOC_S_AUDOUT _IOW('V', 50, struct v4l2_audioout)
- #define VIDIOC_G_MODULATOR _IOWR('V', 54, struct v4l2_modulator)
- #define VIDIOC_S_MODULATOR _IOW('V', 55, struct v4l2_modulator)
- #define VIDIOC_G_FREQUENCY _IOWR('V', 56, struct v4l2_frequency)
- #define VIDIOC_S_FREQUENCY _IOW('V', 57, struct v4l2_frequency)
- #define VIDIOC_CROPCAP _IOWR('V', 58, struct v4l2_cropcap)
- #define VIDIOC_G_CROP _IOWR('V', 59, struct v4l2_crop)
- #define VIDIOC_S_CROP _IOW('V', 60, struct v4l2_crop)
- #define VIDIOC_G_JPEGCOMP _IOR('V', 61, struct v4l2_jpegcompression)
- #define VIDIOC_S_JPEGCOMP _IOW('V', 62, struct v4l2_jpegcompression)
- #define VIDIOC_QUERYSTD _IOR('V', 63, v4l2_std_id)
- #define VIDIOC_TRY_FMT _IOWR('V', 64, struct v4l2_format)
- #define VIDIOC_ENUMAUDIO _IOWR('V', 65, struct v4l2_audio)
- #define VIDIOC_ENUMAUDOUT _IOWR('V', 66, struct v4l2_audioout)
- #define VIDIOC_G_PRIORITY _IOR('V', 67, __u32) /* enum v4l2_priority */
- #define VIDIOC_S_PRIORITY _IOW('V', 68, __u32) /* enum v4l2_priority */
- #define VIDIOC_G_SLICED_VBI_CAP _IOWR('V', 69, struct v4l2_sliced_vbi_cap)
- #define VIDIOC_LOG_STATUS _IO('V', 70)
- #define VIDIOC_G_EXT_CTRLS _IOWR('V', 71, struct v4l2_ext_controls)
- #define VIDIOC_S_EXT_CTRLS _IOWR('V', 72, struct v4l2_ext_controls)
- #define VIDIOC_TRY_EXT_CTRLS _IOWR('V', 73, struct v4l2_ext_controls)
- #define VIDIOC_ENUM_FRAMESIZES _IOWR('V', 74, struct v4l2_frmsizeenum)
- #define VIDIOC_ENUM_FRAMEINTERVALS _IOWR('V', 75, struct v4l2_frmivalenum)
- #define VIDIOC_G_ENC_INDEX _IOR('V', 76, struct v4l2_enc_idx)
- #define VIDIOC_ENCODER_CMD _IOWR('V', 77, struct v4l2_encoder_cmd)
- #define VIDIOC_TRY_ENCODER_CMD _IOWR('V', 78, struct v4l2_encoder_cmd)
-
- /*
- * Experimental, meant for debugging, testing and internal use.
- * Only implemented if CONFIG_VIDEO_ADV_DEBUG is defined.
- * You must be root to use these ioctls. Never use these in applications!
- */
- #define VIDIOC_DBG_S_REGISTER _IOW('V', 79, struct v4l2_dbg_register)
- #define VIDIOC_DBG_G_REGISTER _IOWR('V', 80, struct v4l2_dbg_register)
-
- #define VIDIOC_S_HW_FREQ_SEEK _IOW('V', 82, struct v4l2_hw_freq_seek)
- #define VIDIOC_S_DV_TIMINGS _IOWR('V', 87, struct v4l2_dv_timings)
- #define VIDIOC_G_DV_TIMINGS _IOWR('V', 88, struct v4l2_dv_timings)
- #define VIDIOC_DQEVENT _IOR('V', 89, struct v4l2_event)
- #define VIDIOC_SUBSCRIBE_EVENT _IOW('V', 90, struct v4l2_event_subscription)
- #define VIDIOC_UNSUBSCRIBE_EVENT _IOW('V', 91, struct v4l2_event_subscription)
- #define VIDIOC_CREATE_BUFS _IOWR('V', 92, struct v4l2_create_buffers)
- #define VIDIOC_PREPARE_BUF _IOWR('V', 93, struct v4l2_buffer)
- #define VIDIOC_G_SELECTION _IOWR('V', 94, struct v4l2_selection)
- #define VIDIOC_S_SELECTION _IOWR('V', 95, struct v4l2_selection)
- #define VIDIOC_DECODER_CMD _IOWR('V', 96, struct v4l2_decoder_cmd)
- #define VIDIOC_TRY_DECODER_CMD _IOWR('V', 97, struct v4l2_decoder_cmd)
- #define VIDIOC_ENUM_DV_TIMINGS _IOWR('V', 98, struct v4l2_enum_dv_timings)
- #define VIDIOC_QUERY_DV_TIMINGS _IOR('V', 99, struct v4l2_dv_timings)
- #define VIDIOC_DV_TIMINGS_CAP _IOWR('V', 100, struct v4l2_dv_timings_cap)
- #define VIDIOC_ENUM_FREQ_BANDS _IOWR('V', 101, struct v4l2_frequency_band)
-
- /*
- * Experimental, meant for debugging, testing and internal use.
- * Never use this in applications!
- */
- #define VIDIOC_DBG_G_CHIP_INFO _IOWR('V', 102, struct v4l2_dbg_chip_info)
-
- #define VIDIOC_QUERY_EXT_CTRL _IOWR('V', 103, struct v4l2_query_ext_ctrl)
-
- /* Reminder: when adding new ioctls please add support for them to
- drivers/media/v4l2-core/v4l2-compat-ioctl32.c as well! */
-
- #define BASE_VIDIOC_PRIVATE 192 /* 192-255 are private */
-
- #endif /* _UAPI__LINUX_VIDEODEV2_H */
diff --git a/Documentation/linux_tv/videodev2.h.rst.exceptions b/Documentation/linux_tv/videodev2.h.rst.exceptions
new file mode 100644
index 000000000000..abc9144feba9
--- /dev/null
+++ b/Documentation/linux_tv/videodev2.h.rst.exceptions
@@ -0,0 +1,591 @@
+# Ignore header name
+ignore define _UAPI__LINUX_VIDEODEV2_H
+
+#
+# The cross reference valitator for videodev2.h DocBook never cared
+# about enum symbols or defines. Yet, they're all (or almost all?)
+# handled inside V4L API sections. So, for now, it is safe to just
+# ignore. This should be revisited, as validating it helps to avoid
+# having something not documented at the uAPI.
+#
+
+# for now, ignore all enum symbols
+ignore symbol V4L2_BUF_TYPE_PRIVATE
+ignore symbol V4L2_BUF_TYPE_SDR_CAPTURE
+ignore symbol V4L2_BUF_TYPE_SDR_OUTPUT
+ignore symbol V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
+ignore symbol V4L2_BUF_TYPE_SLICED_VBI_OUTPUT
+ignore symbol V4L2_BUF_TYPE_VBI_CAPTURE
+ignore symbol V4L2_BUF_TYPE_VBI_OUTPUT
+ignore symbol V4L2_BUF_TYPE_VIDEO_CAPTURE
+ignore symbol V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE
+ignore symbol V4L2_BUF_TYPE_VIDEO_OUTPUT
+ignore symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE
+ignore symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY
+ignore symbol V4L2_BUF_TYPE_VIDEO_OVERLAY
+ignore symbol V4L2_COLORSPACE_470_SYSTEM_BG
+ignore symbol V4L2_COLORSPACE_470_SYSTEM_M
+ignore symbol V4L2_COLORSPACE_ADOBERGB
+ignore symbol V4L2_COLORSPACE_BT2020
+ignore symbol V4L2_COLORSPACE_BT878
+ignore symbol V4L2_COLORSPACE_DCI_P3
+ignore symbol V4L2_COLORSPACE_DEFAULT
+ignore symbol V4L2_COLORSPACE_JPEG
+ignore symbol V4L2_COLORSPACE_RAW
+ignore symbol V4L2_COLORSPACE_REC709
+ignore symbol V4L2_COLORSPACE_SMPTE170M
+ignore symbol V4L2_COLORSPACE_SMPTE240M
+ignore symbol V4L2_COLORSPACE_SRGB
+ignore symbol V4L2_CTRL_COMPOUND_TYPES
+ignore symbol V4L2_CTRL_TYPE_BITMASK
+ignore symbol V4L2_CTRL_TYPE_BOOLEAN
+ignore symbol V4L2_CTRL_TYPE_BUTTON
+ignore symbol V4L2_CTRL_TYPE_CTRL_CLASS
+ignore symbol V4L2_CTRL_TYPE_INTEGER
+ignore symbol V4L2_CTRL_TYPE_INTEGER64
+ignore symbol V4L2_CTRL_TYPE_INTEGER_MENU
+ignore symbol V4L2_CTRL_TYPE_MENU
+ignore symbol V4L2_CTRL_TYPE_STRING
+ignore symbol V4L2_CTRL_TYPE_U16
+ignore symbol V4L2_CTRL_TYPE_U32
+ignore symbol V4L2_CTRL_TYPE_U8
+ignore symbol V4L2_FIELD_ALTERNATE
+ignore symbol V4L2_FIELD_ANY
+ignore symbol V4L2_FIELD_BOTTOM
+ignore symbol V4L2_FIELD_INTERLACED
+ignore symbol V4L2_FIELD_INTERLACED_BT
+ignore symbol V4L2_FIELD_INTERLACED_TB
+ignore symbol V4L2_FIELD_NONE
+ignore symbol V4L2_FIELD_SEQ_BT
+ignore symbol V4L2_FIELD_SEQ_TB
+ignore symbol V4L2_FIELD_TOP
+ignore symbol V4L2_FRMIVAL_TYPE_CONTINUOUS
+ignore symbol V4L2_FRMIVAL_TYPE_DISCRETE
+ignore symbol V4L2_FRMIVAL_TYPE_STEPWISE
+ignore symbol V4L2_FRMSIZE_TYPE_CONTINUOUS
+ignore symbol V4L2_FRMSIZE_TYPE_DISCRETE
+ignore symbol V4L2_FRMSIZE_TYPE_STEPWISE
+ignore symbol V4L2_MEMORY_DMABUF
+ignore symbol V4L2_MEMORY_MMAP
+ignore symbol V4L2_MEMORY_OVERLAY
+ignore symbol V4L2_MEMORY_USERPTR
+ignore symbol V4L2_PRIORITY_BACKGROUND
+ignore symbol V4L2_PRIORITY_DEFAULT
+ignore symbol V4L2_PRIORITY_INTERACTIVE
+ignore symbol V4L2_PRIORITY_RECORD
+ignore symbol V4L2_PRIORITY_UNSET
+ignore symbol V4L2_QUANTIZATION_DEFAULT
+ignore symbol V4L2_QUANTIZATION_FULL_RANGE
+ignore symbol V4L2_QUANTIZATION_LIM_RANGE
+ignore symbol V4L2_TUNER_ANALOG_TV
+ignore symbol V4L2_TUNER_DIGITAL_TV
+ignore symbol V4L2_TUNER_RADIO
+ignore symbol V4L2_TUNER_RF
+ignore symbol V4L2_TUNER_SDR
+ignore symbol V4L2_XFER_FUNC_709
+ignore symbol V4L2_XFER_FUNC_ADOBERGB
+ignore symbol V4L2_XFER_FUNC_DCI_P3
+ignore symbol V4L2_XFER_FUNC_DEFAULT
+ignore symbol V4L2_XFER_FUNC_NONE
+ignore symbol V4L2_XFER_FUNC_SMPTE2084
+ignore symbol V4L2_XFER_FUNC_SMPTE240M
+ignore symbol V4L2_XFER_FUNC_SRGB
+ignore symbol V4L2_YCBCR_ENC_601
+ignore symbol V4L2_YCBCR_ENC_709
+ignore symbol V4L2_YCBCR_ENC_BT2020
+ignore symbol V4L2_YCBCR_ENC_BT2020_CONST_LUM
+ignore symbol V4L2_YCBCR_ENC_DEFAULT
+ignore symbol V4L2_YCBCR_ENC_SMPTE240M
+ignore symbol V4L2_YCBCR_ENC_SYCC
+ignore symbol V4L2_YCBCR_ENC_XV601
+ignore symbol V4L2_YCBCR_ENC_XV709
+
+# For now, ignore all defines
+ignore define VIDEO_MAX_FRAME
+ignore define VIDEO_MAX_PLANES
+ignore define v4l2_fourcc
+ignore define v4l2_fourcc_be
+ignore define V4L2_FIELD_HAS_TOP
+ignore define V4L2_FIELD_HAS_BOTTOM
+ignore define V4L2_FIELD_HAS_BOTH
+ignore define V4L2_FIELD_HAS_T_OR_B
+ignore define V4L2_TYPE_IS_MULTIPLANAR
+ignore define V4L2_TYPE_IS_OUTPUT
+ignore define V4L2_TUNER_ADC
+ignore define V4L2_MAP_COLORSPACE_DEFAULT
+ignore define V4L2_MAP_XFER_FUNC_DEFAULT
+ignore define V4L2_MAP_YCBCR_ENC_DEFAULT
+ignore define V4L2_CAP_VIDEO_CAPTURE
+ignore define V4L2_CAP_VIDEO_OUTPUT
+ignore define V4L2_CAP_VIDEO_OVERLAY
+ignore define V4L2_CAP_VBI_CAPTURE
+ignore define V4L2_CAP_VBI_OUTPUT
+ignore define V4L2_CAP_SLICED_VBI_CAPTURE
+ignore define V4L2_CAP_SLICED_VBI_OUTPUT
+ignore define V4L2_CAP_RDS_CAPTURE
+ignore define V4L2_CAP_VIDEO_OUTPUT_OVERLAY
+ignore define V4L2_CAP_HW_FREQ_SEEK
+ignore define V4L2_CAP_RDS_OUTPUT
+ignore define V4L2_CAP_VIDEO_CAPTURE_MPLANE
+ignore define V4L2_CAP_VIDEO_OUTPUT_MPLANE
+ignore define V4L2_CAP_VIDEO_M2M_MPLANE
+ignore define V4L2_CAP_VIDEO_M2M
+ignore define V4L2_CAP_TUNER
+ignore define V4L2_CAP_AUDIO
+ignore define V4L2_CAP_RADIO
+ignore define V4L2_CAP_MODULATOR
+ignore define V4L2_CAP_SDR_CAPTURE
+ignore define V4L2_CAP_EXT_PIX_FORMAT
+ignore define V4L2_CAP_SDR_OUTPUT
+ignore define V4L2_CAP_READWRITE
+ignore define V4L2_CAP_ASYNCIO
+ignore define V4L2_CAP_STREAMING
+ignore define V4L2_CAP_DEVICE_CAPS
+ignore define V4L2_PIX_FMT_RGB332
+ignore define V4L2_PIX_FMT_RGB444
+ignore define V4L2_PIX_FMT_ARGB444
+ignore define V4L2_PIX_FMT_XRGB444
+ignore define V4L2_PIX_FMT_RGB555
+ignore define V4L2_PIX_FMT_ARGB555
+ignore define V4L2_PIX_FMT_XRGB555
+ignore define V4L2_PIX_FMT_RGB565
+ignore define V4L2_PIX_FMT_RGB555X
+ignore define V4L2_PIX_FMT_ARGB555X
+ignore define V4L2_PIX_FMT_XRGB555X
+ignore define V4L2_PIX_FMT_RGB565X
+ignore define V4L2_PIX_FMT_BGR666
+ignore define V4L2_PIX_FMT_BGR24
+ignore define V4L2_PIX_FMT_RGB24
+ignore define V4L2_PIX_FMT_BGR32
+ignore define V4L2_PIX_FMT_ABGR32
+ignore define V4L2_PIX_FMT_XBGR32
+ignore define V4L2_PIX_FMT_RGB32
+ignore define V4L2_PIX_FMT_ARGB32
+ignore define V4L2_PIX_FMT_XRGB32
+ignore define V4L2_PIX_FMT_GREY
+ignore define V4L2_PIX_FMT_Y4
+ignore define V4L2_PIX_FMT_Y6
+ignore define V4L2_PIX_FMT_Y10
+ignore define V4L2_PIX_FMT_Y12
+ignore define V4L2_PIX_FMT_Y16
+ignore define V4L2_PIX_FMT_Y16_BE
+ignore define V4L2_PIX_FMT_Y10BPACK
+ignore define V4L2_PIX_FMT_PAL8
+ignore define V4L2_PIX_FMT_UV8
+ignore define V4L2_PIX_FMT_YUYV
+ignore define V4L2_PIX_FMT_YYUV
+ignore define V4L2_PIX_FMT_YVYU
+ignore define V4L2_PIX_FMT_UYVY
+ignore define V4L2_PIX_FMT_VYUY
+ignore define V4L2_PIX_FMT_Y41P
+ignore define V4L2_PIX_FMT_YUV444
+ignore define V4L2_PIX_FMT_YUV555
+ignore define V4L2_PIX_FMT_YUV565
+ignore define V4L2_PIX_FMT_YUV32
+ignore define V4L2_PIX_FMT_HI240
+ignore define V4L2_PIX_FMT_HM12
+ignore define V4L2_PIX_FMT_M420
+ignore define V4L2_PIX_FMT_NV12
+ignore define V4L2_PIX_FMT_NV21
+ignore define V4L2_PIX_FMT_NV16
+ignore define V4L2_PIX_FMT_NV61
+ignore define V4L2_PIX_FMT_NV24
+ignore define V4L2_PIX_FMT_NV42
+ignore define V4L2_PIX_FMT_NV12M
+ignore define V4L2_PIX_FMT_NV21M
+ignore define V4L2_PIX_FMT_NV16M
+ignore define V4L2_PIX_FMT_NV61M
+ignore define V4L2_PIX_FMT_NV12MT
+ignore define V4L2_PIX_FMT_NV12MT_16X16
+ignore define V4L2_PIX_FMT_YUV410
+ignore define V4L2_PIX_FMT_YVU410
+ignore define V4L2_PIX_FMT_YUV411P
+ignore define V4L2_PIX_FMT_YUV420
+ignore define V4L2_PIX_FMT_YVU420
+ignore define V4L2_PIX_FMT_YUV422P
+ignore define V4L2_PIX_FMT_YUV420M
+ignore define V4L2_PIX_FMT_YVU420M
+ignore define V4L2_PIX_FMT_YUV422M
+ignore define V4L2_PIX_FMT_YVU422M
+ignore define V4L2_PIX_FMT_YUV444M
+ignore define V4L2_PIX_FMT_YVU444M
+ignore define V4L2_PIX_FMT_SBGGR8
+ignore define V4L2_PIX_FMT_SGBRG8
+ignore define V4L2_PIX_FMT_SGRBG8
+ignore define V4L2_PIX_FMT_SRGGB8
+ignore define V4L2_PIX_FMT_SBGGR10
+ignore define V4L2_PIX_FMT_SGBRG10
+ignore define V4L2_PIX_FMT_SGRBG10
+ignore define V4L2_PIX_FMT_SRGGB10
+ignore define V4L2_PIX_FMT_SBGGR10P
+ignore define V4L2_PIX_FMT_SGBRG10P
+ignore define V4L2_PIX_FMT_SGRBG10P
+ignore define V4L2_PIX_FMT_SRGGB10P
+ignore define V4L2_PIX_FMT_SBGGR10ALAW8
+ignore define V4L2_PIX_FMT_SGBRG10ALAW8
+ignore define V4L2_PIX_FMT_SGRBG10ALAW8
+ignore define V4L2_PIX_FMT_SRGGB10ALAW8
+ignore define V4L2_PIX_FMT_SBGGR10DPCM8
+ignore define V4L2_PIX_FMT_SGBRG10DPCM8
+ignore define V4L2_PIX_FMT_SGRBG10DPCM8
+ignore define V4L2_PIX_FMT_SRGGB10DPCM8
+ignore define V4L2_PIX_FMT_SBGGR12
+ignore define V4L2_PIX_FMT_SGBRG12
+ignore define V4L2_PIX_FMT_SGRBG12
+ignore define V4L2_PIX_FMT_SRGGB12
+ignore define V4L2_PIX_FMT_SBGGR16
+ignore define V4L2_PIX_FMT_MJPEG
+ignore define V4L2_PIX_FMT_JPEG
+ignore define V4L2_PIX_FMT_DV
+ignore define V4L2_PIX_FMT_MPEG
+ignore define V4L2_PIX_FMT_H264
+ignore define V4L2_PIX_FMT_H264_NO_SC
+ignore define V4L2_PIX_FMT_H264_MVC
+ignore define V4L2_PIX_FMT_H263
+ignore define V4L2_PIX_FMT_MPEG1
+ignore define V4L2_PIX_FMT_MPEG2
+ignore define V4L2_PIX_FMT_MPEG4
+ignore define V4L2_PIX_FMT_XVID
+ignore define V4L2_PIX_FMT_VC1_ANNEX_G
+ignore define V4L2_PIX_FMT_VC1_ANNEX_L
+ignore define V4L2_PIX_FMT_VP8
+ignore define V4L2_PIX_FMT_CPIA1
+ignore define V4L2_PIX_FMT_WNVA
+ignore define V4L2_PIX_FMT_SN9C10X
+ignore define V4L2_PIX_FMT_SN9C20X_I420
+ignore define V4L2_PIX_FMT_PWC1
+ignore define V4L2_PIX_FMT_PWC2
+ignore define V4L2_PIX_FMT_ET61X251
+ignore define V4L2_PIX_FMT_SPCA501
+ignore define V4L2_PIX_FMT_SPCA505
+ignore define V4L2_PIX_FMT_SPCA508
+ignore define V4L2_PIX_FMT_SPCA561
+ignore define V4L2_PIX_FMT_PAC207
+ignore define V4L2_PIX_FMT_MR97310A
+ignore define V4L2_PIX_FMT_JL2005BCD
+ignore define V4L2_PIX_FMT_SN9C2028
+ignore define V4L2_PIX_FMT_SQ905C
+ignore define V4L2_PIX_FMT_PJPG
+ignore define V4L2_PIX_FMT_OV511
+ignore define V4L2_PIX_FMT_OV518
+ignore define V4L2_PIX_FMT_STV0680
+ignore define V4L2_PIX_FMT_TM6000
+ignore define V4L2_PIX_FMT_CIT_YYVYUY
+ignore define V4L2_PIX_FMT_KONICA420
+ignore define V4L2_PIX_FMT_JPGL
+ignore define V4L2_PIX_FMT_SE401
+ignore define V4L2_PIX_FMT_S5C_UYVY_JPG
+ignore define V4L2_PIX_FMT_Y8I
+ignore define V4L2_PIX_FMT_Y12I
+ignore define V4L2_PIX_FMT_Z16
+ignore define V4L2_SDR_FMT_CU8
+ignore define V4L2_SDR_FMT_CU16LE
+ignore define V4L2_SDR_FMT_CS8
+ignore define V4L2_SDR_FMT_CS14LE
+ignore define V4L2_SDR_FMT_RU12LE
+ignore define V4L2_PIX_FMT_PRIV_MAGIC
+ignore define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA
+ignore define V4L2_FMT_FLAG_COMPRESSED
+ignore define V4L2_FMT_FLAG_EMULATED
+ignore define V4L2_TC_TYPE_24FPS
+ignore define V4L2_TC_TYPE_25FPS
+ignore define V4L2_TC_TYPE_30FPS
+ignore define V4L2_TC_TYPE_50FPS
+ignore define V4L2_TC_TYPE_60FPS
+ignore define V4L2_TC_FLAG_DROPFRAME
+ignore define V4L2_TC_FLAG_COLORFRAME
+ignore define V4L2_TC_USERBITS_field
+ignore define V4L2_TC_USERBITS_USERDEFINED
+ignore define V4L2_TC_USERBITS_8BITCHARS
+ignore define V4L2_JPEG_MARKER_DHT
+ignore define V4L2_JPEG_MARKER_DQT
+ignore define V4L2_JPEG_MARKER_DRI
+ignore define V4L2_JPEG_MARKER_COM
+ignore define V4L2_JPEG_MARKER_APP
+ignore define V4L2_BUF_FLAG_MAPPED
+ignore define V4L2_BUF_FLAG_QUEUED
+ignore define V4L2_BUF_FLAG_DONE
+ignore define V4L2_BUF_FLAG_KEYFRAME
+ignore define V4L2_BUF_FLAG_PFRAME
+ignore define V4L2_BUF_FLAG_BFRAME
+ignore define V4L2_BUF_FLAG_ERROR
+ignore define V4L2_BUF_FLAG_TIMECODE
+ignore define V4L2_BUF_FLAG_PREPARED
+ignore define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE
+ignore define V4L2_BUF_FLAG_NO_CACHE_CLEAN
+ignore define V4L2_BUF_FLAG_TIMESTAMP_MASK
+ignore define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN
+ignore define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC
+ignore define V4L2_BUF_FLAG_TIMESTAMP_COPY
+ignore define V4L2_BUF_FLAG_TSTAMP_SRC_MASK
+ignore define V4L2_BUF_FLAG_TSTAMP_SRC_EOF
+ignore define V4L2_BUF_FLAG_TSTAMP_SRC_SOE
+ignore define V4L2_BUF_FLAG_LAST
+ignore define V4L2_FBUF_CAP_EXTERNOVERLAY
+ignore define V4L2_FBUF_CAP_CHROMAKEY
+ignore define V4L2_FBUF_CAP_LIST_CLIPPING
+ignore define V4L2_FBUF_CAP_BITMAP_CLIPPING
+ignore define V4L2_FBUF_CAP_LOCAL_ALPHA
+ignore define V4L2_FBUF_CAP_GLOBAL_ALPHA
+ignore define V4L2_FBUF_CAP_LOCAL_INV_ALPHA
+ignore define V4L2_FBUF_CAP_SRC_CHROMAKEY
+ignore define V4L2_FBUF_FLAG_PRIMARY
+ignore define V4L2_FBUF_FLAG_OVERLAY
+ignore define V4L2_FBUF_FLAG_CHROMAKEY
+ignore define V4L2_FBUF_FLAG_LOCAL_ALPHA
+ignore define V4L2_FBUF_FLAG_GLOBAL_ALPHA
+ignore define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA
+ignore define V4L2_FBUF_FLAG_SRC_CHROMAKEY
+ignore define V4L2_MODE_HIGHQUALITY
+ignore define V4L2_CAP_TIMEPERFRAME
+ignore define V4L2_STD_PAL_B
+ignore define V4L2_STD_PAL_B1
+ignore define V4L2_STD_PAL_G
+ignore define V4L2_STD_PAL_H
+ignore define V4L2_STD_PAL_I
+ignore define V4L2_STD_PAL_D
+ignore define V4L2_STD_PAL_D1
+ignore define V4L2_STD_PAL_K
+ignore define V4L2_STD_PAL_M
+ignore define V4L2_STD_PAL_N
+ignore define V4L2_STD_PAL_Nc
+ignore define V4L2_STD_PAL_60
+ignore define V4L2_STD_NTSC_M
+ignore define V4L2_STD_NTSC_M_JP
+ignore define V4L2_STD_NTSC_443
+ignore define V4L2_STD_NTSC_M_KR
+ignore define V4L2_STD_SECAM_B
+ignore define V4L2_STD_SECAM_D
+ignore define V4L2_STD_SECAM_G
+ignore define V4L2_STD_SECAM_H
+ignore define V4L2_STD_SECAM_K
+ignore define V4L2_STD_SECAM_K1
+ignore define V4L2_STD_SECAM_L
+ignore define V4L2_STD_SECAM_LC
+ignore define V4L2_STD_ATSC_8_VSB
+ignore define V4L2_STD_ATSC_16_VSB
+ignore define V4L2_STD_NTSC
+ignore define V4L2_STD_SECAM_DK
+ignore define V4L2_STD_SECAM
+ignore define V4L2_STD_PAL_BG
+ignore define V4L2_STD_PAL_DK
+ignore define V4L2_STD_PAL
+ignore define V4L2_STD_B
+ignore define V4L2_STD_G
+ignore define V4L2_STD_H
+ignore define V4L2_STD_L
+ignore define V4L2_STD_GH
+ignore define V4L2_STD_DK
+ignore define V4L2_STD_BG
+ignore define V4L2_STD_MN
+ignore define V4L2_STD_MTS
+ignore define V4L2_STD_525_60
+ignore define V4L2_STD_625_50
+ignore define V4L2_STD_ATSC
+ignore define V4L2_STD_UNKNOWN
+ignore define V4L2_STD_ALL
+ignore define V4L2_DV_PROGRESSIVE
+ignore define V4L2_DV_INTERLACED
+ignore define V4L2_DV_VSYNC_POS_POL
+ignore define V4L2_DV_HSYNC_POS_POL
+ignore define V4L2_DV_BT_STD_CEA861
+ignore define V4L2_DV_BT_STD_DMT
+ignore define V4L2_DV_BT_STD_CVT
+ignore define V4L2_DV_BT_STD_GTF
+ignore define V4L2_DV_FL_REDUCED_BLANKING
+ignore define V4L2_DV_FL_CAN_REDUCE_FPS
+ignore define V4L2_DV_FL_REDUCED_FPS
+ignore define V4L2_DV_FL_HALF_LINE
+ignore define V4L2_DV_FL_IS_CE_VIDEO
+ignore define V4L2_DV_BT_BLANKING_WIDTH(bt)
+ignore define V4L2_DV_BT_FRAME_WIDTH(bt)
+ignore define V4L2_DV_BT_BLANKING_HEIGHT(bt)
+ignore define V4L2_DV_BT_FRAME_HEIGHT(bt)
+ignore define V4L2_DV_BT_656_1120
+ignore define V4L2_DV_BT_CAP_INTERLACED
+ignore define V4L2_DV_BT_CAP_PROGRESSIVE
+ignore define V4L2_DV_BT_CAP_REDUCED_BLANKING
+ignore define V4L2_DV_BT_CAP_CUSTOM
+ignore define V4L2_INPUT_TYPE_TUNER
+ignore define V4L2_INPUT_TYPE_CAMERA
+ignore define V4L2_IN_ST_NO_POWER
+ignore define V4L2_IN_ST_NO_SIGNAL
+ignore define V4L2_IN_ST_NO_COLOR
+ignore define V4L2_IN_ST_HFLIP
+ignore define V4L2_IN_ST_VFLIP
+ignore define V4L2_IN_ST_NO_H_LOCK
+ignore define V4L2_IN_ST_COLOR_KILL
+ignore define V4L2_IN_ST_NO_SYNC
+ignore define V4L2_IN_ST_NO_EQU
+ignore define V4L2_IN_ST_NO_CARRIER
+ignore define V4L2_IN_ST_MACROVISION
+ignore define V4L2_IN_ST_NO_ACCESS
+ignore define V4L2_IN_ST_VTR
+ignore define V4L2_IN_CAP_DV_TIMINGS
+ignore define V4L2_IN_CAP_CUSTOM_TIMINGS
+ignore define V4L2_IN_CAP_STD
+ignore define V4L2_IN_CAP_NATIVE_SIZE
+ignore define V4L2_OUTPUT_TYPE_MODULATOR
+ignore define V4L2_OUTPUT_TYPE_ANALOG
+ignore define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY
+ignore define V4L2_OUT_CAP_DV_TIMINGS
+ignore define V4L2_OUT_CAP_CUSTOM_TIMINGS
+ignore define V4L2_OUT_CAP_STD
+ignore define V4L2_OUT_CAP_NATIVE_SIZE
+ignore define V4L2_CTRL_ID_MASK
+ignore define V4L2_CTRL_ID2CLASS(id)
+ignore define V4L2_CTRL_ID2WHICH(id)
+ignore define V4L2_CTRL_DRIVER_PRIV(id)
+ignore define V4L2_CTRL_MAX_DIMS
+ignore define V4L2_CTRL_WHICH_CUR_VAL
+ignore define V4L2_CTRL_WHICH_DEF_VAL
+ignore define V4L2_CTRL_FLAG_DISABLED
+ignore define V4L2_CTRL_FLAG_GRABBED
+ignore define V4L2_CTRL_FLAG_READ_ONLY
+ignore define V4L2_CTRL_FLAG_UPDATE
+ignore define V4L2_CTRL_FLAG_INACTIVE
+ignore define V4L2_CTRL_FLAG_SLIDER
+ignore define V4L2_CTRL_FLAG_WRITE_ONLY
+ignore define V4L2_CTRL_FLAG_VOLATILE
+ignore define V4L2_CTRL_FLAG_HAS_PAYLOAD
+ignore define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE
+ignore define V4L2_CTRL_FLAG_NEXT_CTRL
+ignore define V4L2_CTRL_FLAG_NEXT_COMPOUND
+ignore define V4L2_CID_MAX_CTRLS
+ignore define V4L2_CID_PRIVATE_BASE
+ignore define V4L2_TUNER_CAP_LOW
+ignore define V4L2_TUNER_CAP_NORM
+ignore define V4L2_TUNER_CAP_HWSEEK_BOUNDED
+ignore define V4L2_TUNER_CAP_HWSEEK_WRAP
+ignore define V4L2_TUNER_CAP_STEREO
+ignore define V4L2_TUNER_CAP_LANG2
+ignore define V4L2_TUNER_CAP_SAP
+ignore define V4L2_TUNER_CAP_LANG1
+ignore define V4L2_TUNER_CAP_RDS
+ignore define V4L2_TUNER_CAP_RDS_BLOCK_IO
+ignore define V4L2_TUNER_CAP_RDS_CONTROLS
+ignore define V4L2_TUNER_CAP_FREQ_BANDS
+ignore define V4L2_TUNER_CAP_HWSEEK_PROG_LIM
+ignore define V4L2_TUNER_CAP_1HZ
+ignore define V4L2_TUNER_SUB_MONO
+ignore define V4L2_TUNER_SUB_STEREO
+ignore define V4L2_TUNER_SUB_LANG2
+ignore define V4L2_TUNER_SUB_SAP
+ignore define V4L2_TUNER_SUB_LANG1
+ignore define V4L2_TUNER_SUB_RDS
+ignore define V4L2_TUNER_MODE_MONO
+ignore define V4L2_TUNER_MODE_STEREO
+ignore define V4L2_TUNER_MODE_LANG2
+ignore define V4L2_TUNER_MODE_SAP
+ignore define V4L2_TUNER_MODE_LANG1
+ignore define V4L2_TUNER_MODE_LANG1_LANG2
+ignore define V4L2_BAND_MODULATION_VSB
+ignore define V4L2_BAND_MODULATION_FM
+ignore define V4L2_BAND_MODULATION_AM
+ignore define V4L2_RDS_BLOCK_MSK
+ignore define V4L2_RDS_BLOCK_A
+ignore define V4L2_RDS_BLOCK_B
+ignore define V4L2_RDS_BLOCK_C
+ignore define V4L2_RDS_BLOCK_D
+ignore define V4L2_RDS_BLOCK_C_ALT
+ignore define V4L2_RDS_BLOCK_INVALID
+ignore define V4L2_RDS_BLOCK_CORRECTED
+ignore define V4L2_RDS_BLOCK_ERROR
+ignore define V4L2_AUDCAP_STEREO
+ignore define V4L2_AUDCAP_AVL
+ignore define V4L2_AUDMODE_AVL
+ignore define V4L2_ENC_IDX_FRAME_I
+ignore define V4L2_ENC_IDX_FRAME_P
+ignore define V4L2_ENC_IDX_FRAME_B
+ignore define V4L2_ENC_IDX_FRAME_MASK
+ignore define V4L2_ENC_IDX_ENTRIES
+ignore define V4L2_ENC_CMD_START
+ignore define V4L2_ENC_CMD_STOP
+ignore define V4L2_ENC_CMD_PAUSE
+ignore define V4L2_ENC_CMD_RESUME
+ignore define V4L2_ENC_CMD_STOP_AT_GOP_END
+ignore define V4L2_DEC_CMD_START
+ignore define V4L2_DEC_CMD_STOP
+ignore define V4L2_DEC_CMD_PAUSE
+ignore define V4L2_DEC_CMD_RESUME
+ignore define V4L2_DEC_CMD_START_MUTE_AUDIO
+ignore define V4L2_DEC_CMD_PAUSE_TO_BLACK
+ignore define V4L2_DEC_CMD_STOP_TO_BLACK
+ignore define V4L2_DEC_CMD_STOP_IMMEDIATELY
+ignore define V4L2_DEC_START_FMT_NONE
+ignore define V4L2_DEC_START_FMT_GOP
+ignore define V4L2_VBI_UNSYNC
+ignore define V4L2_VBI_INTERLACED
+ignore define V4L2_VBI_ITU_525_F1_START
+ignore define V4L2_VBI_ITU_525_F2_START
+ignore define V4L2_VBI_ITU_625_F1_START
+ignore define V4L2_VBI_ITU_625_F2_START
+ignore define V4L2_SLICED_TELETEXT_B
+ignore define V4L2_SLICED_VPS
+ignore define V4L2_SLICED_CAPTION_525
+ignore define V4L2_SLICED_WSS_625
+ignore define V4L2_SLICED_VBI_525
+ignore define V4L2_SLICED_VBI_625
+ignore define V4L2_MPEG_VBI_IVTV_TELETEXT_B
+ignore define V4L2_MPEG_VBI_IVTV_CAPTION_525
+ignore define V4L2_MPEG_VBI_IVTV_WSS_625
+ignore define V4L2_MPEG_VBI_IVTV_VPS
+ignore define V4L2_MPEG_VBI_IVTV_MAGIC0
+ignore define V4L2_MPEG_VBI_IVTV_MAGIC1
+ignore define V4L2_EVENT_ALL
+ignore define V4L2_EVENT_VSYNC
+ignore define V4L2_EVENT_EOS
+ignore define V4L2_EVENT_CTRL
+ignore define V4L2_EVENT_FRAME_SYNC
+ignore define V4L2_EVENT_SOURCE_CHANGE
+ignore define V4L2_EVENT_PRIVATE_START
+ignore define V4L2_EVENT_CTRL_CH_VALUE
+ignore define V4L2_EVENT_CTRL_CH_FLAGS
+ignore define V4L2_EVENT_CTRL_CH_RANGE
+ignore define V4L2_EVENT_SRC_CH_RESOLUTION
+ignore define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ
+ignore define V4L2_EVENT_SUB_FL_SEND_INITIAL
+ignore define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK
+ignore define V4L2_CHIP_MATCH_BRIDGE
+ignore define V4L2_CHIP_MATCH_SUBDEV
+ignore define V4L2_CHIP_MATCH_HOST
+ignore define V4L2_CHIP_MATCH_I2C_DRIVER
+ignore define V4L2_CHIP_MATCH_I2C_ADDR
+ignore define V4L2_CHIP_MATCH_AC97
+ignore define V4L2_CHIP_FL_READABLE
+ignore define V4L2_CHIP_FL_WRITABLE
+ignore define BASE_VIDIOC_PRIVATE
+
+# Ignore reserved ioctl
+ignore ioctl VIDIOC_RESERVED
+
+# Associate ioctls with their counterparts
+replace ioctl VIDIOC_DBG_S_REGISTER vidioc_dbg_g_register
+replace ioctl VIDIOC_DQBUF vidioc_qbuf
+replace ioctl VIDIOC_S_AUDOUT vidioc_g_audout
+replace ioctl VIDIOC_S_CROP vidioc_g_crop
+replace ioctl VIDIOC_S_CTRL vidioc_g_ctrl
+replace ioctl VIDIOC_S_DV_TIMINGS vidioc_g_dv_timings
+replace ioctl VIDIOC_S_EDID vidioc_g_edid
+replace ioctl VIDIOC_S_EXT_CTRLS vidioc_g_ext_ctrls
+replace ioctl VIDIOC_S_FBUF vidioc_g_fbuf
+replace ioctl VIDIOC_S_FMT vidioc_g_fmt
+replace ioctl VIDIOC_S_FREQUENCY vidioc_g_frequency
+replace ioctl VIDIOC_S_INPUT vidioc_g_input
+replace ioctl VIDIOC_S_JPEGCOMP vidioc_g_jpegcomp
+replace ioctl VIDIOC_S_MODULATOR vidioc_g_modulator
+replace ioctl VIDIOC_S_OUTPUT vidioc_g_output
+replace ioctl VIDIOC_S_PARM vidioc_g_parm
+replace ioctl VIDIOC_S_PRIORITY vidioc_g_priority
+replace ioctl VIDIOC_S_SELECTION vidioc_g_selection
+replace ioctl VIDIOC_S_STD vidioc_g_std
+replace ioctl VIDIOC_S_AUDIO vidioc_g_audio
+replace ioctl VIDIOC_S_TUNER vidioc_g_tuner
+replace ioctl VIDIOC_TRY_DECODER_CMD vidioc_decoder_cmd
+replace ioctl VIDIOC_TRY_ENCODER_CMD vidioc_encoder_cmd
+replace ioctl VIDIOC_TRY_EXT_CTRLS vidioc_g_ext_ctrls
+replace ioctl VIDIOC_TRY_FMT vidioc_g_fmt
+replace ioctl VIDIOC_STREAMOFF vidioc_streamon
+replace ioctl VIDIOC_UNSUBSCRIBE_EVENT vidioc_subscribe_event
+replace ioctl VIDIOC_QUERY_EXT_CTRL vidioc_queryctrl
+replace ioctl VIDIOC_QUERYMENU vidioc_queryctrl
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 46/54] doc-rst: fix some badly converted references
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (44 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 45/54] doc-rst: autogenerate videodev2.h.rst file Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 47/54] doc-rst: linux_tv: Don't ignore pix formats Mauro Carvalho Chehab
` (8 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Several references were not converted right. That's why
so many symbols were lost when parsing videodev2.h header.
Fix them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/dvb/dmx_types.rst | 8 +-
.../linux_tv/media/dvb/fe-bandwidth-t.rst | 14 +-
.../linux_tv/media/dvb/fe-diseqc-send-burst.rst | 4 +-
Documentation/linux_tv/media/dvb/fe-get-info.rst | 62 +++----
.../linux_tv/media/dvb/fe-read-status.rst | 14 +-
Documentation/linux_tv/media/dvb/fe-set-tone.rst | 4 +-
Documentation/linux_tv/media/dvb/fe-type-t.rst | 8 +-
.../linux_tv/media/dvb/fe_property_parameters.rst | 206 ++++++++++-----------
Documentation/linux_tv/media/v4l/control.rst | 6 +-
.../linux_tv/media/v4l/extended-controls.rst | 114 ++++++------
Documentation/linux_tv/media/v4l/pixfmt-013.rst | 26 +--
.../linux_tv/media/v4l/pixfmt-indexed.rst | 2 +-
.../linux_tv/media/v4l/pixfmt-packed-rgb.rst | 42 ++---
.../linux_tv/media/v4l/pixfmt-packed-yuv.rst | 8 +-
.../linux_tv/media/v4l/pixfmt-reserved.rst | 66 +++----
.../linux_tv/media/v4l/subdev-formats.rst | 174 ++++++++---------
16 files changed, 379 insertions(+), 379 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/dmx_types.rst b/Documentation/linux_tv/media/dvb/dmx_types.rst
index 84bf616ff623..7a8900af2680 100644
--- a/Documentation/linux_tv/media/dvb/dmx_types.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_types.rst
@@ -28,7 +28,7 @@ Output for the demux
- .. row 2
- - .. _`DMX-OUT-DECODER`:
+ - .. _DMX-OUT-DECODER:
DMX_OUT_DECODER
@@ -36,7 +36,7 @@ Output for the demux
- .. row 3
- - .. _`DMX-OUT-TAP`:
+ - .. _DMX-OUT-TAP:
DMX_OUT_TAP
@@ -46,7 +46,7 @@ Output for the demux
- .. row 4
- - .. _`DMX-OUT-TS-TAP`:
+ - .. _DMX-OUT-TS-TAP:
DMX_OUT_TS_TAP
@@ -57,7 +57,7 @@ Output for the demux
- .. row 5
- - .. _`DMX-OUT-TSDEMUX-TAP`:
+ - .. _DMX-OUT-TSDEMUX-TAP:
DMX_OUT_TSDEMUX_TAP
diff --git a/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst b/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst
index f614c22355da..8edaf1a8fbc8 100644
--- a/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst
+++ b/Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst
@@ -22,7 +22,7 @@ Frontend bandwidth
- .. row 2
- - .. _`BANDWIDTH-AUTO`:
+ - .. _BANDWIDTH-AUTO:
``BANDWIDTH_AUTO``
@@ -30,7 +30,7 @@ Frontend bandwidth
- .. row 3
- - .. _`BANDWIDTH-1-712-MHZ`:
+ - .. _BANDWIDTH-1-712-MHZ:
``BANDWIDTH_1_712_MHZ``
@@ -38,7 +38,7 @@ Frontend bandwidth
- .. row 4
- - .. _`BANDWIDTH-5-MHZ`:
+ - .. _BANDWIDTH-5-MHZ:
``BANDWIDTH_5_MHZ``
@@ -46,7 +46,7 @@ Frontend bandwidth
- .. row 5
- - .. _`BANDWIDTH-6-MHZ`:
+ - .. _BANDWIDTH-6-MHZ:
``BANDWIDTH_6_MHZ``
@@ -54,7 +54,7 @@ Frontend bandwidth
- .. row 6
- - .. _`BANDWIDTH-7-MHZ`:
+ - .. _BANDWIDTH-7-MHZ:
``BANDWIDTH_7_MHZ``
@@ -62,7 +62,7 @@ Frontend bandwidth
- .. row 7
- - .. _`BANDWIDTH-8-MHZ`:
+ - .. _BANDWIDTH-8-MHZ:
``BANDWIDTH_8_MHZ``
@@ -70,7 +70,7 @@ Frontend bandwidth
- .. row 8
- - .. _`BANDWIDTH-10-MHZ`:
+ - .. _BANDWIDTH-10-MHZ:
``BANDWIDTH_10_MHZ``
diff --git a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
index 11d441c6f237..9b476545ef89 100644
--- a/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
+++ b/Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst
@@ -61,7 +61,7 @@ enum fe_sec_mini_cmd
- .. row 2
- - .. _`SEC-MINI-A`:
+ - .. _SEC-MINI-A:
``SEC_MINI_A``
@@ -69,7 +69,7 @@ enum fe_sec_mini_cmd
- .. row 3
- - .. _`SEC-MINI-B`:
+ - .. _SEC-MINI-B:
``SEC_MINI_B``
diff --git a/Documentation/linux_tv/media/dvb/fe-get-info.rst b/Documentation/linux_tv/media/dvb/fe-get-info.rst
index 8ef1ed7bbf68..9a9ddbcdb1ec 100644
--- a/Documentation/linux_tv/media/dvb/fe-get-info.rst
+++ b/Documentation/linux_tv/media/dvb/fe-get-info.rst
@@ -172,7 +172,7 @@ supported only on some specific frontend types.
- .. row 2
- - .. _`FE-IS-STUPID`:
+ - .. _FE-IS-STUPID:
``FE_IS_STUPID``
@@ -181,7 +181,7 @@ supported only on some specific frontend types.
- .. row 3
- - .. _`FE-CAN-INVERSION-AUTO`:
+ - .. _FE-CAN-INVERSION-AUTO:
``FE_CAN_INVERSION_AUTO``
@@ -189,7 +189,7 @@ supported only on some specific frontend types.
- .. row 4
- - .. _`FE-CAN-FEC-1-2`:
+ - .. _FE-CAN-FEC-1-2:
``FE_CAN_FEC_1_2``
@@ -197,7 +197,7 @@ supported only on some specific frontend types.
- .. row 5
- - .. _`FE-CAN-FEC-2-3`:
+ - .. _FE-CAN-FEC-2-3:
``FE_CAN_FEC_2_3``
@@ -205,7 +205,7 @@ supported only on some specific frontend types.
- .. row 6
- - .. _`FE-CAN-FEC-3-4`:
+ - .. _FE-CAN-FEC-3-4:
``FE_CAN_FEC_3_4``
@@ -213,7 +213,7 @@ supported only on some specific frontend types.
- .. row 7
- - .. _`FE-CAN-FEC-4-5`:
+ - .. _FE-CAN-FEC-4-5:
``FE_CAN_FEC_4_5``
@@ -221,7 +221,7 @@ supported only on some specific frontend types.
- .. row 8
- - .. _`FE-CAN-FEC-5-6`:
+ - .. _FE-CAN-FEC-5-6:
``FE_CAN_FEC_5_6``
@@ -229,7 +229,7 @@ supported only on some specific frontend types.
- .. row 9
- - .. _`FE-CAN-FEC-6-7`:
+ - .. _FE-CAN-FEC-6-7:
``FE_CAN_FEC_6_7``
@@ -237,7 +237,7 @@ supported only on some specific frontend types.
- .. row 10
- - .. _`FE-CAN-FEC-7-8`:
+ - .. _FE-CAN-FEC-7-8:
``FE_CAN_FEC_7_8``
@@ -245,7 +245,7 @@ supported only on some specific frontend types.
- .. row 11
- - .. _`FE-CAN-FEC-8-9`:
+ - .. _FE-CAN-FEC-8-9:
``FE_CAN_FEC_8_9``
@@ -253,7 +253,7 @@ supported only on some specific frontend types.
- .. row 12
- - .. _`FE-CAN-FEC-AUTO`:
+ - .. _FE-CAN-FEC-AUTO:
``FE_CAN_FEC_AUTO``
@@ -261,7 +261,7 @@ supported only on some specific frontend types.
- .. row 13
- - .. _`FE-CAN-QPSK`:
+ - .. _FE-CAN-QPSK:
``FE_CAN_QPSK``
@@ -269,7 +269,7 @@ supported only on some specific frontend types.
- .. row 14
- - .. _`FE-CAN-QAM-16`:
+ - .. _FE-CAN-QAM-16:
``FE_CAN_QAM_16``
@@ -277,7 +277,7 @@ supported only on some specific frontend types.
- .. row 15
- - .. _`FE-CAN-QAM-32`:
+ - .. _FE-CAN-QAM-32:
``FE_CAN_QAM_32``
@@ -285,7 +285,7 @@ supported only on some specific frontend types.
- .. row 16
- - .. _`FE-CAN-QAM-64`:
+ - .. _FE-CAN-QAM-64:
``FE_CAN_QAM_64``
@@ -293,7 +293,7 @@ supported only on some specific frontend types.
- .. row 17
- - .. _`FE-CAN-QAM-128`:
+ - .. _FE-CAN-QAM-128:
``FE_CAN_QAM_128``
@@ -301,7 +301,7 @@ supported only on some specific frontend types.
- .. row 18
- - .. _`FE-CAN-QAM-256`:
+ - .. _FE-CAN-QAM-256:
``FE_CAN_QAM_256``
@@ -309,7 +309,7 @@ supported only on some specific frontend types.
- .. row 19
- - .. _`FE-CAN-QAM-AUTO`:
+ - .. _FE-CAN-QAM-AUTO:
``FE_CAN_QAM_AUTO``
@@ -317,7 +317,7 @@ supported only on some specific frontend types.
- .. row 20
- - .. _`FE-CAN-TRANSMISSION-MODE-AUTO`:
+ - .. _FE-CAN-TRANSMISSION-MODE-AUTO:
``FE_CAN_TRANSMISSION_MODE_AUTO``
@@ -325,7 +325,7 @@ supported only on some specific frontend types.
- .. row 21
- - .. _`FE-CAN-BANDWIDTH-AUTO`:
+ - .. _FE-CAN-BANDWIDTH-AUTO:
``FE_CAN_BANDWIDTH_AUTO``
@@ -333,7 +333,7 @@ supported only on some specific frontend types.
- .. row 22
- - .. _`FE-CAN-GUARD-INTERVAL-AUTO`:
+ - .. _FE-CAN-GUARD-INTERVAL-AUTO:
``FE_CAN_GUARD_INTERVAL_AUTO``
@@ -341,7 +341,7 @@ supported only on some specific frontend types.
- .. row 23
- - .. _`FE-CAN-HIERARCHY-AUTO`:
+ - .. _FE-CAN-HIERARCHY-AUTO:
``FE_CAN_HIERARCHY_AUTO``
@@ -349,7 +349,7 @@ supported only on some specific frontend types.
- .. row 24
- - .. _`FE-CAN-8VSB`:
+ - .. _FE-CAN-8VSB:
``FE_CAN_8VSB``
@@ -357,7 +357,7 @@ supported only on some specific frontend types.
- .. row 25
- - .. _`FE-CAN-16VSB`:
+ - .. _FE-CAN-16VSB:
``FE_CAN_16VSB``
@@ -365,7 +365,7 @@ supported only on some specific frontend types.
- .. row 26
- - .. _`FE-HAS-EXTENDED-CAPS`:
+ - .. _FE-HAS-EXTENDED-CAPS:
``FE_HAS_EXTENDED_CAPS``
@@ -373,7 +373,7 @@ supported only on some specific frontend types.
- .. row 27
- - .. _`FE-CAN-MULTISTREAM`:
+ - .. _FE-CAN-MULTISTREAM:
``FE_CAN_MULTISTREAM``
@@ -381,7 +381,7 @@ supported only on some specific frontend types.
- .. row 28
- - .. _`FE-CAN-TURBO-FEC`:
+ - .. _FE-CAN-TURBO-FEC:
``FE_CAN_TURBO_FEC``
@@ -389,7 +389,7 @@ supported only on some specific frontend types.
- .. row 29
- - .. _`FE-CAN-2G-MODULATION`:
+ - .. _FE-CAN-2G-MODULATION:
``FE_CAN_2G_MODULATION``
@@ -397,7 +397,7 @@ supported only on some specific frontend types.
- .. row 30
- - .. _`FE-NEEDS-BENDING`:
+ - .. _FE-NEEDS-BENDING:
``FE_NEEDS_BENDING``
@@ -405,7 +405,7 @@ supported only on some specific frontend types.
- .. row 31
- - .. _`FE-CAN-RECOVER`:
+ - .. _FE-CAN-RECOVER:
``FE_CAN_RECOVER``
@@ -413,7 +413,7 @@ supported only on some specific frontend types.
- .. row 32
- - .. _`FE-CAN-MUTE-TS`:
+ - .. _FE-CAN-MUTE-TS:
``FE_CAN_MUTE_TS``
diff --git a/Documentation/linux_tv/media/dvb/fe-read-status.rst b/Documentation/linux_tv/media/dvb/fe-read-status.rst
index 544ce49ee091..339955fbe133 100644
--- a/Documentation/linux_tv/media/dvb/fe-read-status.rst
+++ b/Documentation/linux_tv/media/dvb/fe-read-status.rst
@@ -70,7 +70,7 @@ state changes of the frontend hardware. It is produced using the enum
- .. row 2
- - .. _`FE-HAS-SIGNAL`:
+ - .. _FE-HAS-SIGNAL:
``FE_HAS_SIGNAL``
@@ -78,7 +78,7 @@ state changes of the frontend hardware. It is produced using the enum
- .. row 3
- - .. _`FE-HAS-CARRIER`:
+ - .. _FE-HAS-CARRIER:
``FE_HAS_CARRIER``
@@ -86,7 +86,7 @@ state changes of the frontend hardware. It is produced using the enum
- .. row 4
- - .. _`FE-HAS-VITERBI`:
+ - .. _FE-HAS-VITERBI:
``FE_HAS_VITERBI``
@@ -95,7 +95,7 @@ state changes of the frontend hardware. It is produced using the enum
- .. row 5
- - .. _`FE-HAS-SYNC`:
+ - .. _FE-HAS-SYNC:
``FE_HAS_SYNC``
@@ -103,7 +103,7 @@ state changes of the frontend hardware. It is produced using the enum
- .. row 6
- - .. _`FE-HAS-LOCK`:
+ - .. _FE-HAS-LOCK:
``FE_HAS_LOCK``
@@ -111,7 +111,7 @@ state changes of the frontend hardware. It is produced using the enum
- .. row 7
- - .. _`FE-TIMEDOUT`:
+ - .. _FE-TIMEDOUT:
``FE_TIMEDOUT``
@@ -119,7 +119,7 @@ state changes of the frontend hardware. It is produced using the enum
- .. row 8
- - .. _`FE-REINIT`:
+ - .. _FE-REINIT:
``FE_REINIT``
diff --git a/Documentation/linux_tv/media/dvb/fe-set-tone.rst b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
index 16bf6b73f8d5..763b61d91004 100644
--- a/Documentation/linux_tv/media/dvb/fe-set-tone.rst
+++ b/Documentation/linux_tv/media/dvb/fe-set-tone.rst
@@ -67,7 +67,7 @@ enum fe_sec_tone_mode
- .. row 2
- - .. _`SEC-TONE-ON`:
+ - .. _SEC-TONE-ON:
``SEC_TONE_ON``
@@ -75,7 +75,7 @@ enum fe_sec_tone_mode
- .. row 3
- - .. _`SEC-TONE-OFF`:
+ - .. _SEC-TONE-OFF:
``SEC_TONE_OFF``
diff --git a/Documentation/linux_tv/media/dvb/fe-type-t.rst b/Documentation/linux_tv/media/dvb/fe-type-t.rst
index 0c26af5d3a92..8ca762b42e4d 100644
--- a/Documentation/linux_tv/media/dvb/fe-type-t.rst
+++ b/Documentation/linux_tv/media/dvb/fe-type-t.rst
@@ -30,7 +30,7 @@ fe_type_t type, defined as:
- .. row 2
- - .. _`FE-QPSK`:
+ - .. _FE-QPSK:
``FE_QPSK``
@@ -40,7 +40,7 @@ fe_type_t type, defined as:
- .. row 3
- - .. _`FE-QAM`:
+ - .. _FE-QAM:
``FE_QAM``
@@ -50,7 +50,7 @@ fe_type_t type, defined as:
- .. row 4
- - .. _`FE-OFDM`:
+ - .. _FE-OFDM:
``FE_OFDM``
@@ -60,7 +60,7 @@ fe_type_t type, defined as:
- .. row 5
- - .. _`FE-ATSC`:
+ - .. _FE-ATSC:
``FE_ATSC``
diff --git a/Documentation/linux_tv/media/dvb/fe_property_parameters.rst b/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
index b6142ee1acfb..47eb29350717 100644
--- a/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
+++ b/Documentation/linux_tv/media/dvb/fe_property_parameters.rst
@@ -91,7 +91,7 @@ modulations are supported by a given standard.
- .. row 2
- - .. _`QPSK`:
+ - .. _QPSK:
``QPSK``
@@ -99,7 +99,7 @@ modulations are supported by a given standard.
- .. row 3
- - .. _`QAM-16`:
+ - .. _QAM-16:
``QAM_16``
@@ -107,7 +107,7 @@ modulations are supported by a given standard.
- .. row 4
- - .. _`QAM-32`:
+ - .. _QAM-32:
``QAM_32``
@@ -115,7 +115,7 @@ modulations are supported by a given standard.
- .. row 5
- - .. _`QAM-64`:
+ - .. _QAM-64:
``QAM_64``
@@ -123,7 +123,7 @@ modulations are supported by a given standard.
- .. row 6
- - .. _`QAM-128`:
+ - .. _QAM-128:
``QAM_128``
@@ -131,7 +131,7 @@ modulations are supported by a given standard.
- .. row 7
- - .. _`QAM-256`:
+ - .. _QAM-256:
``QAM_256``
@@ -139,7 +139,7 @@ modulations are supported by a given standard.
- .. row 8
- - .. _`QAM-AUTO`:
+ - .. _QAM-AUTO:
``QAM_AUTO``
@@ -147,7 +147,7 @@ modulations are supported by a given standard.
- .. row 9
- - .. _`VSB-8`:
+ - .. _VSB-8:
``VSB_8``
@@ -155,7 +155,7 @@ modulations are supported by a given standard.
- .. row 10
- - .. _`VSB-16`:
+ - .. _VSB-16:
``VSB_16``
@@ -163,7 +163,7 @@ modulations are supported by a given standard.
- .. row 11
- - .. _`PSK-8`:
+ - .. _PSK-8:
``PSK_8``
@@ -171,7 +171,7 @@ modulations are supported by a given standard.
- .. row 12
- - .. _`APSK-16`:
+ - .. _APSK-16:
``APSK_16``
@@ -179,7 +179,7 @@ modulations are supported by a given standard.
- .. row 13
- - .. _`APSK-32`:
+ - .. _APSK-32:
``APSK_32``
@@ -187,7 +187,7 @@ modulations are supported by a given standard.
- .. row 14
- - .. _`DQPSK`:
+ - .. _DQPSK:
``DQPSK``
@@ -195,7 +195,7 @@ modulations are supported by a given standard.
- .. row 15
- - .. _`QAM-4-NR`:
+ - .. _QAM-4-NR:
``QAM_4_NR``
@@ -267,7 +267,7 @@ inversion off. If it fails, it will try to enable inversion.
- .. row 2
- - .. _`INVERSION-OFF`:
+ - .. _INVERSION-OFF:
``INVERSION_OFF``
@@ -275,7 +275,7 @@ inversion off. If it fails, it will try to enable inversion.
- .. row 3
- - .. _`INVERSION-ON`:
+ - .. _INVERSION-ON:
``INVERSION_ON``
@@ -283,7 +283,7 @@ inversion off. If it fails, it will try to enable inversion.
- .. row 4
- - .. _`INVERSION-AUTO`:
+ - .. _INVERSION-AUTO:
``INVERSION_AUTO``
@@ -337,7 +337,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 2
- - .. _`FEC-NONE`:
+ - .. _FEC-NONE:
``FEC_NONE``
@@ -345,7 +345,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 3
- - .. _`FEC-AUTO`:
+ - .. _FEC-AUTO:
``FEC_AUTO``
@@ -353,7 +353,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 4
- - .. _`FEC-1-2`:
+ - .. _FEC-1-2:
``FEC_1_2``
@@ -361,7 +361,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 5
- - .. _`FEC-2-3`:
+ - .. _FEC-2-3:
``FEC_2_3``
@@ -369,7 +369,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 6
- - .. _`FEC-3-4`:
+ - .. _FEC-3-4:
``FEC_3_4``
@@ -377,7 +377,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 7
- - .. _`FEC-4-5`:
+ - .. _FEC-4-5:
``FEC_4_5``
@@ -385,7 +385,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 8
- - .. _`FEC-5-6`:
+ - .. _FEC-5-6:
``FEC_5_6``
@@ -393,7 +393,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 9
- - .. _`FEC-6-7`:
+ - .. _FEC-6-7:
``FEC_6_7``
@@ -401,7 +401,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 10
- - .. _`FEC-7-8`:
+ - .. _FEC-7-8:
``FEC_7_8``
@@ -409,7 +409,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 11
- - .. _`FEC-8-9`:
+ - .. _FEC-8-9:
``FEC_8_9``
@@ -417,7 +417,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 12
- - .. _`FEC-9-10`:
+ - .. _FEC-9-10:
``FEC_9_10``
@@ -425,7 +425,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 13
- - .. _`FEC-2-5`:
+ - .. _FEC-2-5:
``FEC_2_5``
@@ -433,7 +433,7 @@ enum fe_code_rate: type of the Forward Error Correction.
- .. row 14
- - .. _`FEC-3-5`:
+ - .. _FEC-3-5:
``FEC_3_5``
@@ -467,7 +467,7 @@ described in the DiSEqC spec.
- .. row 2
- - .. _`SEC-VOLTAGE-13`:
+ - .. _SEC-VOLTAGE-13:
``SEC_VOLTAGE_13``
@@ -475,7 +475,7 @@ described in the DiSEqC spec.
- .. row 3
- - .. _`SEC-VOLTAGE-18`:
+ - .. _SEC-VOLTAGE-18:
``SEC_VOLTAGE_18``
@@ -483,7 +483,7 @@ described in the DiSEqC spec.
- .. row 4
- - .. _`SEC-VOLTAGE-OFF`:
+ - .. _SEC-VOLTAGE-OFF:
``SEC_VOLTAGE_OFF``
@@ -528,7 +528,7 @@ fe_pilot type
- .. row 2
- - .. _`PILOT-ON`:
+ - .. _PILOT-ON:
``PILOT_ON``
@@ -536,7 +536,7 @@ fe_pilot type
- .. row 3
- - .. _`PILOT-OFF`:
+ - .. _PILOT-OFF:
``PILOT_OFF``
@@ -544,7 +544,7 @@ fe_pilot type
- .. row 4
- - .. _`PILOT-AUTO`:
+ - .. _PILOT-AUTO:
``PILOT_AUTO``
@@ -581,7 +581,7 @@ fe_rolloff type
- .. row 2
- - .. _`ROLLOFF-35`:
+ - .. _ROLLOFF-35:
``ROLLOFF_35``
@@ -589,7 +589,7 @@ fe_rolloff type
- .. row 3
- - .. _`ROLLOFF-20`:
+ - .. _ROLLOFF-20:
``ROLLOFF_20``
@@ -597,7 +597,7 @@ fe_rolloff type
- .. row 4
- - .. _`ROLLOFF-25`:
+ - .. _ROLLOFF-25:
``ROLLOFF_25``
@@ -605,7 +605,7 @@ fe_rolloff type
- .. row 5
- - .. _`ROLLOFF-AUTO`:
+ - .. _ROLLOFF-AUTO:
``ROLLOFF_AUTO``
@@ -668,7 +668,7 @@ Possible values:
- .. row 2
- - .. _`SYS-UNDEFINED`:
+ - .. _SYS-UNDEFINED:
``SYS_UNDEFINED``
@@ -676,7 +676,7 @@ Possible values:
- .. row 3
- - .. _`SYS-DVBC-ANNEX-A`:
+ - .. _SYS-DVBC-ANNEX-A:
``SYS_DVBC_ANNEX_A``
@@ -684,7 +684,7 @@ Possible values:
- .. row 4
- - .. _`SYS-DVBC-ANNEX-B`:
+ - .. _SYS-DVBC-ANNEX-B:
``SYS_DVBC_ANNEX_B``
@@ -692,7 +692,7 @@ Possible values:
- .. row 5
- - .. _`SYS-DVBC-ANNEX-C`:
+ - .. _SYS-DVBC-ANNEX-C:
``SYS_DVBC_ANNEX_C``
@@ -700,7 +700,7 @@ Possible values:
- .. row 6
- - .. _`SYS-ISDBC`:
+ - .. _SYS-ISDBC:
``SYS_ISDBC``
@@ -708,7 +708,7 @@ Possible values:
- .. row 7
- - .. _`SYS-DVBT`:
+ - .. _SYS-DVBT:
``SYS_DVBT``
@@ -716,7 +716,7 @@ Possible values:
- .. row 8
- - .. _`SYS-DVBT2`:
+ - .. _SYS-DVBT2:
``SYS_DVBT2``
@@ -724,7 +724,7 @@ Possible values:
- .. row 9
- - .. _`SYS-ISDBT`:
+ - .. _SYS-ISDBT:
``SYS_ISDBT``
@@ -732,7 +732,7 @@ Possible values:
- .. row 10
- - .. _`SYS-ATSC`:
+ - .. _SYS-ATSC:
``SYS_ATSC``
@@ -740,7 +740,7 @@ Possible values:
- .. row 11
- - .. _`SYS-ATSCMH`:
+ - .. _SYS-ATSCMH:
``SYS_ATSCMH``
@@ -748,7 +748,7 @@ Possible values:
- .. row 12
- - .. _`SYS-DTMB`:
+ - .. _SYS-DTMB:
``SYS_DTMB``
@@ -756,7 +756,7 @@ Possible values:
- .. row 13
- - .. _`SYS-DVBS`:
+ - .. _SYS-DVBS:
``SYS_DVBS``
@@ -764,7 +764,7 @@ Possible values:
- .. row 14
- - .. _`SYS-DVBS2`:
+ - .. _SYS-DVBS2:
``SYS_DVBS2``
@@ -772,7 +772,7 @@ Possible values:
- .. row 15
- - .. _`SYS-TURBO`:
+ - .. _SYS-TURBO:
``SYS_TURBO``
@@ -780,7 +780,7 @@ Possible values:
- .. row 16
- - .. _`SYS-ISDBS`:
+ - .. _SYS-ISDBS:
``SYS_ISDBS``
@@ -788,7 +788,7 @@ Possible values:
- .. row 17
- - .. _`SYS-DAB`:
+ - .. _SYS-DAB:
``SYS_DAB``
@@ -796,7 +796,7 @@ Possible values:
- .. row 18
- - .. _`SYS-DSS`:
+ - .. _SYS-DSS:
``SYS_DSS``
@@ -804,7 +804,7 @@ Possible values:
- .. row 19
- - .. _`SYS-CMMB`:
+ - .. _SYS-CMMB:
``SYS_CMMB``
@@ -812,7 +812,7 @@ Possible values:
- .. row 20
- - .. _`SYS-DVBH`:
+ - .. _SYS-DVBH:
``SYS_DVBH``
@@ -1238,7 +1238,7 @@ Possible values are:
- .. row 2
- - .. _`ATSCMH-RSFRAME-PRI-ONLY`:
+ - .. _ATSCMH-RSFRAME-PRI-ONLY:
``ATSCMH_RSFRAME_PRI_ONLY``
@@ -1247,7 +1247,7 @@ Possible values are:
- .. row 3
- - .. _`ATSCMH-RSFRAME-PRI-SEC`:
+ - .. _ATSCMH-RSFRAME-PRI-SEC:
``ATSCMH_RSFRAME_PRI_SEC``
@@ -1282,7 +1282,7 @@ Possible values are:
- .. row 2
- - .. _`ATSCMH-RSFRAME-ENS-PRI`:
+ - .. _ATSCMH-RSFRAME-ENS-PRI:
``ATSCMH_RSFRAME_ENS_PRI``
@@ -1290,7 +1290,7 @@ Possible values are:
- .. row 3
- - .. _`ATSCMH-RSFRAME-ENS-SEC`:
+ - .. _ATSCMH-RSFRAME-ENS-SEC:
``AATSCMH_RSFRAME_PRI_SEC``
@@ -1298,7 +1298,7 @@ Possible values are:
- .. row 4
- - .. _`ATSCMH-RSFRAME-RES`:
+ - .. _ATSCMH-RSFRAME-RES:
``AATSCMH_RSFRAME_RES``
@@ -1331,7 +1331,7 @@ Possible values are:
- .. row 2
- - .. _`ATSCMH-RSCODE-211-187`:
+ - .. _ATSCMH-RSCODE-211-187:
``ATSCMH_RSCODE_211_187``
@@ -1339,7 +1339,7 @@ Possible values are:
- .. row 3
- - .. _`ATSCMH-RSCODE-223-187`:
+ - .. _ATSCMH-RSCODE-223-187:
``ATSCMH_RSCODE_223_187``
@@ -1347,7 +1347,7 @@ Possible values are:
- .. row 4
- - .. _`ATSCMH-RSCODE-235-187`:
+ - .. _ATSCMH-RSCODE-235-187:
``ATSCMH_RSCODE_235_187``
@@ -1355,7 +1355,7 @@ Possible values are:
- .. row 5
- - .. _`ATSCMH-RSCODE-RES`:
+ - .. _ATSCMH-RSCODE-RES:
``ATSCMH_RSCODE_RES``
@@ -1399,7 +1399,7 @@ Possible values are:
- .. row 2
- - .. _`ATSCMH-SCCC-BLK-SEP`:
+ - .. _ATSCMH-SCCC-BLK-SEP:
``ATSCMH_SCCC_BLK_SEP``
@@ -1408,7 +1408,7 @@ Possible values are:
- .. row 3
- - .. _`ATSCMH-SCCC-BLK-COMB`:
+ - .. _ATSCMH-SCCC-BLK-COMB:
``ATSCMH_SCCC_BLK_COMB``
@@ -1417,7 +1417,7 @@ Possible values are:
- .. row 4
- - .. _`ATSCMH-SCCC-BLK-RES`:
+ - .. _ATSCMH-SCCC-BLK-RES:
``ATSCMH_SCCC_BLK_RES``
@@ -1450,7 +1450,7 @@ Possible values are:
- .. row 2
- - .. _`ATSCMH-SCCC-CODE-HLF`:
+ - .. _ATSCMH-SCCC-CODE-HLF:
``ATSCMH_SCCC_CODE_HLF``
@@ -1458,7 +1458,7 @@ Possible values are:
- .. row 3
- - .. _`ATSCMH-SCCC-CODE-QTR`:
+ - .. _ATSCMH-SCCC-CODE-QTR:
``ATSCMH_SCCC_CODE_QTR``
@@ -1466,7 +1466,7 @@ Possible values are:
- .. row 4
- - .. _`ATSCMH-SCCC-CODE-RES`:
+ - .. _ATSCMH-SCCC-CODE-RES:
``ATSCMH_SCCC_CODE_RES``
@@ -1562,7 +1562,7 @@ Modulation guard interval
- .. row 2
- - .. _`GUARD-INTERVAL-AUTO`:
+ - .. _GUARD-INTERVAL-AUTO:
``GUARD_INTERVAL_AUTO``
@@ -1570,7 +1570,7 @@ Modulation guard interval
- .. row 3
- - .. _`GUARD-INTERVAL-1-128`:
+ - .. _GUARD-INTERVAL-1-128:
``GUARD_INTERVAL_1_128``
@@ -1578,7 +1578,7 @@ Modulation guard interval
- .. row 4
- - .. _`GUARD-INTERVAL-1-32`:
+ - .. _GUARD-INTERVAL-1-32:
``GUARD_INTERVAL_1_32``
@@ -1586,7 +1586,7 @@ Modulation guard interval
- .. row 5
- - .. _`GUARD-INTERVAL-1-16`:
+ - .. _GUARD-INTERVAL-1-16:
``GUARD_INTERVAL_1_16``
@@ -1594,7 +1594,7 @@ Modulation guard interval
- .. row 6
- - .. _`GUARD-INTERVAL-1-8`:
+ - .. _GUARD-INTERVAL-1-8:
``GUARD_INTERVAL_1_8``
@@ -1602,7 +1602,7 @@ Modulation guard interval
- .. row 7
- - .. _`GUARD-INTERVAL-1-4`:
+ - .. _GUARD-INTERVAL-1-4:
``GUARD_INTERVAL_1_4``
@@ -1610,7 +1610,7 @@ Modulation guard interval
- .. row 8
- - .. _`GUARD-INTERVAL-19-128`:
+ - .. _GUARD-INTERVAL-19-128:
``GUARD_INTERVAL_19_128``
@@ -1618,7 +1618,7 @@ Modulation guard interval
- .. row 9
- - .. _`GUARD-INTERVAL-19-256`:
+ - .. _GUARD-INTERVAL-19-256:
``GUARD_INTERVAL_19_256``
@@ -1626,7 +1626,7 @@ Modulation guard interval
- .. row 10
- - .. _`GUARD-INTERVAL-PN420`:
+ - .. _GUARD-INTERVAL-PN420:
``GUARD_INTERVAL_PN420``
@@ -1634,7 +1634,7 @@ Modulation guard interval
- .. row 11
- - .. _`GUARD-INTERVAL-PN595`:
+ - .. _GUARD-INTERVAL-PN595:
``GUARD_INTERVAL_PN595``
@@ -1642,7 +1642,7 @@ Modulation guard interval
- .. row 12
- - .. _`GUARD-INTERVAL-PN945`:
+ - .. _GUARD-INTERVAL-PN945:
``GUARD_INTERVAL_PN945``
@@ -1691,7 +1691,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 2
- - .. _`TRANSMISSION-MODE-AUTO`:
+ - .. _TRANSMISSION-MODE-AUTO:
``TRANSMISSION_MODE_AUTO``
@@ -1700,7 +1700,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 3
- - .. _`TRANSMISSION-MODE-1K`:
+ - .. _TRANSMISSION-MODE-1K:
``TRANSMISSION_MODE_1K``
@@ -1708,7 +1708,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 4
- - .. _`TRANSMISSION-MODE-2K`:
+ - .. _TRANSMISSION-MODE-2K:
``TRANSMISSION_MODE_2K``
@@ -1716,7 +1716,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 5
- - .. _`TRANSMISSION-MODE-8K`:
+ - .. _TRANSMISSION-MODE-8K:
``TRANSMISSION_MODE_8K``
@@ -1724,7 +1724,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 6
- - .. _`TRANSMISSION-MODE-4K`:
+ - .. _TRANSMISSION-MODE-4K:
``TRANSMISSION_MODE_4K``
@@ -1732,7 +1732,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 7
- - .. _`TRANSMISSION-MODE-16K`:
+ - .. _TRANSMISSION-MODE-16K:
``TRANSMISSION_MODE_16K``
@@ -1740,7 +1740,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 8
- - .. _`TRANSMISSION-MODE-32K`:
+ - .. _TRANSMISSION-MODE-32K:
``TRANSMISSION_MODE_32K``
@@ -1748,7 +1748,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 9
- - .. _`TRANSMISSION-MODE-C1`:
+ - .. _TRANSMISSION-MODE-C1:
``TRANSMISSION_MODE_C1``
@@ -1756,7 +1756,7 @@ enum fe_transmit_mode: Number of carriers per channel
- .. row 10
- - .. _`TRANSMISSION-MODE-C3780`:
+ - .. _TRANSMISSION-MODE-C3780:
``TRANSMISSION_MODE_C3780``
@@ -1808,7 +1808,7 @@ Frontend hierarchy
- .. row 2
- - .. _`HIERARCHY-NONE`:
+ - .. _HIERARCHY-NONE:
``HIERARCHY_NONE``
@@ -1816,7 +1816,7 @@ Frontend hierarchy
- .. row 3
- - .. _`HIERARCHY-AUTO`:
+ - .. _HIERARCHY-AUTO:
``HIERARCHY_AUTO``
@@ -1824,7 +1824,7 @@ Frontend hierarchy
- .. row 4
- - .. _`HIERARCHY-1`:
+ - .. _HIERARCHY-1:
``HIERARCHY_1``
@@ -1832,7 +1832,7 @@ Frontend hierarchy
- .. row 5
- - .. _`HIERARCHY-2`:
+ - .. _HIERARCHY-2:
``HIERARCHY_2``
@@ -1840,7 +1840,7 @@ Frontend hierarchy
- .. row 6
- - .. _`HIERARCHY-4`:
+ - .. _HIERARCHY-4:
``HIERARCHY_4``
@@ -1915,7 +1915,7 @@ Time interleaving to be used. Currently, used only on DTMB.
- .. row 2
- - .. _`INTERLEAVING-NONE`:
+ - .. _INTERLEAVING-NONE:
``INTERLEAVING_NONE``
@@ -1923,7 +1923,7 @@ Time interleaving to be used. Currently, used only on DTMB.
- .. row 3
- - .. _`INTERLEAVING-AUTO`:
+ - .. _INTERLEAVING-AUTO:
``INTERLEAVING_AUTO``
@@ -1931,7 +1931,7 @@ Time interleaving to be used. Currently, used only on DTMB.
- .. row 4
- - .. _`INTERLEAVING-240`:
+ - .. _INTERLEAVING-240:
``INTERLEAVING_240``
@@ -1939,7 +1939,7 @@ Time interleaving to be used. Currently, used only on DTMB.
- .. row 5
- - .. _`INTERLEAVING-720`:
+ - .. _INTERLEAVING-720:
``INTERLEAVING_720``
diff --git a/Documentation/linux_tv/media/v4l/control.rst b/Documentation/linux_tv/media/v4l/control.rst
index de88007a8dff..6cf218ab36fb 100644
--- a/Documentation/linux_tv/media/v4l/control.rst
+++ b/Documentation/linux_tv/media/v4l/control.rst
@@ -143,7 +143,7 @@ Control IDs
``V4L2_CID_VFLIP`` ``(boolean)``
Mirror the picture vertically.
-.. _`v4l2-power-line-frequency`:
+.. _v4l2-power-line-frequency:
``V4L2_CID_POWER_LINE_FREQUENCY`` ``(enum)``
Enables a power line frequency filter to avoid flicker. Possible
@@ -184,7 +184,7 @@ Control IDs
Enable the color killer (i. e. force a black & white image in case
of a weak video signal).
-.. _`v4l2-colorfx`:
+.. _v4l2-colorfx:
``V4L2_CID_COLORFX`` ``(enum)``
Selects a color effect. The following values are defined:
@@ -337,7 +337,7 @@ Control IDs
REQBUFS. The value is the minimum number of OUTPUT buffers that is
necessary for hardware to work.
-.. _`v4l2-alpha-component`:
+.. _v4l2-alpha-component:
``V4L2_CID_ALPHA_COMPONENT`` ``(integer)``
Sets the alpha color component. When a capture device (or capture
diff --git a/Documentation/linux_tv/media/v4l/extended-controls.rst b/Documentation/linux_tv/media/v4l/extended-controls.rst
index d18c3b9896d9..26eb6ee851c3 100644
--- a/Documentation/linux_tv/media/v4l/extended-controls.rst
+++ b/Documentation/linux_tv/media/v4l/extended-controls.rst
@@ -202,7 +202,7 @@ Codec Control IDs
return a description of this control class. This description can be
used as the caption of a Tab page in a GUI, for example.
-.. _`v4l2-mpeg-stream-type`:
+.. _v4l2-mpeg-stream-type:
``V4L2_CID_MPEG_STREAM_TYPE (enum v4l2_mpeg_stream_type)``
The MPEG-1, -2 or -4 output stream type. One cannot assume anything
@@ -275,7 +275,7 @@ Codec Control IDs
``V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (integer)``
Video ID for MPEG PES
-.. _`v4l2-mpeg-stream-vbi-fmt`:
+.. _v4l2-mpeg-stream-vbi-fmt:
``V4L2_CID_MPEG_STREAM_VBI_FMT (enum v4l2_mpeg_stream_vbi_fmt)``
Some cards can embed VBI data (e. g. Closed Caption, Teletext) into
@@ -307,7 +307,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-sampling-freq`:
+.. _v4l2-mpeg-audio-sampling-freq:
``V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ (enum v4l2_mpeg_audio_sampling_freq)``
MPEG Audio sampling frequency. Possible values are:
@@ -339,7 +339,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-encoding`:
+.. _v4l2-mpeg-audio-encoding:
``V4L2_CID_MPEG_AUDIO_ENCODING (enum v4l2_mpeg_audio_encoding)``
MPEG Audio encoding. This control is specific to multiplexed MPEG
@@ -384,7 +384,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-l1-bitrate`:
+.. _v4l2-mpeg-audio-l1-bitrate:
``V4L2_CID_MPEG_AUDIO_L1_BITRATE (enum v4l2_mpeg_audio_l1_bitrate)``
MPEG-1/2 Layer I bitrate. Possible values are:
@@ -482,7 +482,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-l2-bitrate`:
+.. _v4l2-mpeg-audio-l2-bitrate:
``V4L2_CID_MPEG_AUDIO_L2_BITRATE (enum v4l2_mpeg_audio_l2_bitrate)``
MPEG-1/2 Layer II bitrate. Possible values are:
@@ -580,7 +580,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-l3-bitrate`:
+.. _v4l2-mpeg-audio-l3-bitrate:
``V4L2_CID_MPEG_AUDIO_L3_BITRATE (enum v4l2_mpeg_audio_l3_bitrate)``
MPEG-1/2 Layer III bitrate. Possible values are:
@@ -681,7 +681,7 @@ Codec Control IDs
``V4L2_CID_MPEG_AUDIO_AAC_BITRATE (integer)``
AAC bitrate in bits per second.
-.. _`v4l2-mpeg-audio-ac3-bitrate`:
+.. _v4l2-mpeg-audio-ac3-bitrate:
``V4L2_CID_MPEG_AUDIO_AC3_BITRATE (enum v4l2_mpeg_audio_ac3_bitrate)``
AC-3 bitrate. Possible values are:
@@ -809,7 +809,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-mode`:
+.. _v4l2-mpeg-audio-mode:
``V4L2_CID_MPEG_AUDIO_MODE (enum v4l2_mpeg_audio_mode)``
MPEG Audio mode. Possible values are:
@@ -847,7 +847,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-mode-extension`:
+.. _v4l2-mpeg-audio-mode-extension:
``V4L2_CID_MPEG_AUDIO_MODE_EXTENSION (enum v4l2_mpeg_audio_mode_extension)``
Joint Stereo audio mode extension. In Layer I and II they indicate
@@ -887,7 +887,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-emphasis`:
+.. _v4l2-mpeg-audio-emphasis:
``V4L2_CID_MPEG_AUDIO_EMPHASIS (enum v4l2_mpeg_audio_emphasis)``
Audio Emphasis. Possible values are:
@@ -919,7 +919,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-crc`:
+.. _v4l2-mpeg-audio-crc:
``V4L2_CID_MPEG_AUDIO_CRC (enum v4l2_mpeg_audio_crc)``
CRC method. Possible values are:
@@ -951,7 +951,7 @@ Codec Control IDs
itself, guaranteeing a fixed and reproducible audio bitstream. 0 =
unmuted, 1 = muted.
-.. _`v4l2-mpeg-audio-dec-playback`:
+.. _v4l2-mpeg-audio-dec-playback:
``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK (enum v4l2_mpeg_audio_dec_playback)``
Determines how monolingual audio should be played back. Possible
@@ -1002,12 +1002,12 @@ Codec Control IDs
-.. _`v4l2-mpeg-audio-dec-multilingual-playback`:
+.. _v4l2-mpeg-audio-dec-multilingual-playback:
``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK (enum v4l2_mpeg_audio_dec_playback)``
Determines how multilingual audio should be played back.
-.. _`v4l2-mpeg-video-encoding`:
+.. _v4l2-mpeg-video-encoding:
``V4L2_CID_MPEG_VIDEO_ENCODING (enum v4l2_mpeg_video_encoding)``
MPEG Video encoding method. This control is specific to multiplexed
@@ -1040,7 +1040,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-video-aspect`:
+.. _v4l2-mpeg-video-aspect:
``V4L2_CID_MPEG_VIDEO_ASPECT (enum v4l2_mpeg_video_aspect)``
Video aspect. Possible values are:
@@ -1082,7 +1082,7 @@ Codec Control IDs
``V4L2_CID_MPEG_VIDEO_PULLDOWN (boolean)``
Enable 3:2 pulldown (default 0)
-.. _`v4l2-mpeg-video-bitrate-mode`:
+.. _v4l2-mpeg-video-bitrate-mode:
``V4L2_CID_MPEG_VIDEO_BITRATE_MODE (enum v4l2_mpeg_video_bitrate_mode)``
Video bitrate mode. Possible values are:
@@ -1162,7 +1162,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-video-dec-pts`:
+.. _v4l2-mpeg-video-dec-pts:
``V4L2_CID_MPEG_VIDEO_DEC_PTS (integer64)``
This read-only control returns the 33-bit video Presentation Time
@@ -1170,7 +1170,7 @@ Codec Control IDs
currently displayed frame. This is the same PTS as is used in
:ref:`VIDIOC_DECODER_CMD`.
-.. _`v4l2-mpeg-video-dec-frame`:
+.. _v4l2-mpeg-video-dec-frame:
``V4L2_CID_MPEG_VIDEO_DEC_FRAME (integer64)``
This read-only control returns the frame counter of the frame that
@@ -1186,7 +1186,7 @@ Codec Control IDs
Enable writing sample aspect ratio in the Video Usability
Information. Applicable to the H264 encoder.
-.. _`v4l2-mpeg-video-h264-vui-sar-idc`:
+.. _v4l2-mpeg-video-h264-vui-sar-idc:
``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC (enum v4l2_mpeg_video_h264_vui_sar_idc)``
VUI sample aspect ratio indicator for H.264 encoding. The value is
@@ -1318,7 +1318,7 @@ Codec Control IDs
Extended sample aspect ratio height for H.264 VUI encoding.
Applicable to the H264 encoder.
-.. _`v4l2-mpeg-video-h264-level`:
+.. _v4l2-mpeg-video-h264-level:
``V4L2_CID_MPEG_VIDEO_H264_LEVEL (enum v4l2_mpeg_video_h264_level)``
The level information for the H264 video elementary stream.
@@ -1429,7 +1429,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-video-mpeg4-level`:
+.. _v4l2-mpeg-video-mpeg4-level:
``V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL (enum v4l2_mpeg_video_mpeg4_level)``
The level information for the MPEG4 elementary stream. Applicable to
@@ -1492,7 +1492,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-video-h264-profile`:
+.. _v4l2-mpeg-video-h264-profile:
``V4L2_CID_MPEG_VIDEO_H264_PROFILE (enum v4l2_mpeg_video_h264_profile)``
The profile information for H264. Applicable to the H264 encoder.
@@ -1609,7 +1609,7 @@ Codec Control IDs
-.. _`v4l2-mpeg-video-mpeg4-profile`:
+.. _v4l2-mpeg-video-mpeg4-profile:
``V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE (enum v4l2_mpeg_video_mpeg4_profile)``
The profile information for MPEG4. Applicable to the MPEG4 encoder.
@@ -1658,7 +1658,7 @@ Codec Control IDs
The maximum number of reference pictures used for encoding.
Applicable to the encoder.
-.. _`v4l2-mpeg-video-multi-slice-mode`:
+.. _v4l2-mpeg-video-multi-slice-mode:
``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE (enum v4l2_mpeg_video_multi_slice_mode)``
Determines how the encoder should handle division of frame into
@@ -1703,7 +1703,7 @@ Codec Control IDs
``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES``. Applicable to the
encoder.
-.. _`v4l2-mpeg-video-h264-loop-filter-mode`:
+.. _v4l2-mpeg-video-h264-loop-filter-mode:
``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE (enum v4l2_mpeg_video_h264_loop_filter_mode)``
Loop filter mode for H264 encoder. Possible values are:
@@ -1743,7 +1743,7 @@ Codec Control IDs
Loop filter beta coefficient, defined in the H264 standard.
Applicable to the H264 encoder.
-.. _`v4l2-mpeg-video-h264-entropy-mode`:
+.. _v4l2-mpeg-video-h264-entropy-mode:
``V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE (enum v4l2_mpeg_video_h264_entropy_mode)``
Entropy coding mode for H264 - CABAC/CAVALC. Applicable to the H264
@@ -1861,12 +1861,12 @@ Codec Control IDs
data rate that an encoder or editing process may produce.".
Applicable to the MPEG1, MPEG2, MPEG4 encoders.
-.. _`v4l2-mpeg-video-vbv-delay`:
+.. _v4l2-mpeg-video-vbv-delay:
``V4L2_CID_MPEG_VIDEO_VBV_DELAY (integer)``
Sets the initial delay in milliseconds for VBV buffer control.
-.. _`v4l2-mpeg-video-hor-search-range`:
+.. _v4l2-mpeg-video-hor-search-range:
``V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE (integer)``
Horizontal search range defines maximum horizontal search area in
@@ -1874,7 +1874,7 @@ Codec Control IDs
reference picture. This V4L2 control macro is used to set horizontal
search range for motion estimation module in video encoder.
-.. _`v4l2-mpeg-video-vert-search-range`:
+.. _v4l2-mpeg-video-vert-search-range:
``V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE (integer)``
Vertical search range defines maximum vertical search area in pixels
@@ -1882,7 +1882,7 @@ Codec Control IDs
picture. This V4L2 control macro is used to set vertical search
range for motion estimation module in video encoder.
-.. _`v4l2-mpeg-video-force-key-frame`:
+.. _v4l2-mpeg-video-force-key-frame:
``V4L2_CID_MPEG_VIDEO_FORCE_KEY_FRAME (button)``
Force a key frame for the next queued buffer. Applicable to
@@ -1904,7 +1904,7 @@ Codec Control IDs
the need to store or decode any previous frames. Applicable to the
H264 encoder.
-.. _`v4l2-mpeg-video-header-mode`:
+.. _v4l2-mpeg-video-header-mode:
``V4L2_CID_MPEG_VIDEO_HEADER_MODE (enum v4l2_mpeg_video_header_mode)``
Determines whether the header is returned as the first buffer or is
@@ -1960,7 +1960,7 @@ Codec Control IDs
Sets current frame as frame0 in frame packing SEI. Applicable to the
H264 encoder.
-.. _`v4l2-mpeg-video-h264-sei-fp-arrangement-type`:
+.. _v4l2-mpeg-video-h264-sei-fp-arrangement-type:
``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE (enum v4l2_mpeg_video_h264_sei_fp_arrangement_type)``
Frame packing arrangement type for H264 SEI. Applicable to the H264
@@ -2016,7 +2016,7 @@ Codec Control IDs
a technique used for restructuring the ordering of macroblocks in
pictures. Applicable to the H264 encoder.
-.. _`v4l2-mpeg-video-h264-fmo-map-type`:
+.. _v4l2-mpeg-video-h264-fmo-map-type:
``V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE (enum v4l2_mpeg_video_h264_fmo_map_type)``
When using FMO, the map type divides the image in different scan
@@ -2079,7 +2079,7 @@ Codec Control IDs
``V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP (integer)``
Number of slice groups in FMO. Applicable to the H264 encoder.
-.. _`v4l2-mpeg-video-h264-fmo-change-direction`:
+.. _v4l2-mpeg-video-h264-fmo-change-direction:
``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION (enum v4l2_mpeg_video_h264_fmo_change_dir)``
Specifies a direction of the slice group change for raster and wipe
@@ -2147,7 +2147,7 @@ Codec Control IDs
``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING (boolean)``
Enables H264 hierarchical coding. Applicable to the H264 encoder.
-.. _`v4l2-mpeg-video-h264-hierarchical-coding-type`:
+.. _v4l2-mpeg-video-h264-hierarchical-coding-type:
``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE (enum v4l2_mpeg_video_h264_hierarchical_coding_type)``
Specifies the hierarchical coding type. Applicable to the H264
@@ -2314,7 +2314,7 @@ MFC 5.1 Control IDs
(``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
encoder.
-.. _`v4l2-mpeg-mfc51-video-frame-skip-mode`:
+.. _v4l2-mpeg-mfc51-video-frame-skip-mode:
``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE (enum v4l2_mpeg_mfc51_video_frame_skip_mode)``
Indicates in what conditions the encoder should skip frames. If
@@ -2363,7 +2363,7 @@ MFC 5.1 Control IDs
the other hand enabling this setting will ensure that the stream
will meet tight bandwidth constraints. Applicable to encoders.
-.. _`v4l2-mpeg-mfc51-video-force-frame-type`:
+.. _v4l2-mpeg-mfc51-video-force-frame-type:
``V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE (enum v4l2_mpeg_mfc51_video_force_frame_type)``
Force a frame type for the next queued buffer. Applicable to
@@ -2409,7 +2409,7 @@ are specific to the Conexant CX23415 and CX23416 MPEG encoding chips.
CX2341x Control IDs
^^^^^^^^^^^^^^^^^^^
-.. _`v4l2-mpeg-cx2341x-video-spatial-filter-mode`:
+.. _v4l2-mpeg-cx2341x-video-spatial-filter-mode:
``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE (enum v4l2_mpeg_cx2341x_video_spatial_filter_mode)``
Sets the Spatial Filter mode (default ``MANUAL``). Possible values
@@ -2440,7 +2440,7 @@ CX2341x Control IDs
The setting for the Spatial Filter. 0 = off, 15 = maximum. (Default
is 0.)
-.. _`luma-spatial-filter-type`:
+.. _luma-spatial-filter-type:
``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE (enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type)``
Select the algorithm to use for the Luma Spatial Filter (default
@@ -2485,7 +2485,7 @@ CX2341x Control IDs
-.. _`chroma-spatial-filter-type`:
+.. _chroma-spatial-filter-type:
``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE (enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type)``
Select the algorithm for the Chroma Spatial Filter (default
@@ -2512,7 +2512,7 @@ CX2341x Control IDs
-.. _`v4l2-mpeg-cx2341x-video-temporal-filter-mode`:
+.. _v4l2-mpeg-cx2341x-video-temporal-filter-mode:
``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE (enum v4l2_mpeg_cx2341x_video_temporal_filter_mode)``
Sets the Temporal Filter mode (default ``MANUAL``). Possible values
@@ -2543,7 +2543,7 @@ CX2341x Control IDs
The setting for the Temporal Filter. 0 = off, 31 = maximum. (Default
is 8 for full-scale capturing and 0 for scaled capturing.)
-.. _`v4l2-mpeg-cx2341x-video-median-filter-type`:
+.. _v4l2-mpeg-cx2341x-video-median-filter-type:
``V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE (enum v4l2_mpeg_cx2341x_video_median_filter_type)``
Median Filter Type (default ``OFF``). Possible values are:
@@ -2624,7 +2624,7 @@ codec.
VPX Control IDs
^^^^^^^^^^^^^^^
-.. _`v4l2-vpx-num-partitions`:
+.. _v4l2-vpx-num-partitions:
``V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS (enum v4l2_vp8_num_partitions)``
The number of token partitions to use in VP8 encoder. Possible
@@ -2666,7 +2666,7 @@ VPX Control IDs
``V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4 (boolean)``
Setting this prevents intra 4x4 mode in the intra mode decision.
-.. _`v4l2-vpx-num-ref-frames`:
+.. _v4l2-vpx-num-ref-frames:
``V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES (enum v4l2_vp8_num_ref_frames)``
The number of reference pictures for encoding P frames. Possible
@@ -2719,7 +2719,7 @@ VPX Control IDs
frame refresh period is set as 4, the frames 0, 4, 8 etc will be
taken as the golden frames as frame 0 is always a key frame.
-.. _`v4l2-vpx-golden-frame-sel`:
+.. _v4l2-vpx-golden-frame-sel:
``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL (enum v4l2_vp8_golden_frame_sel)``
Selects the golden frame for encoding. Possible values are:
@@ -2784,7 +2784,7 @@ Camera Control IDs
:ref:`VIDIOC_QUERYCTRL` for this control will
return a description of this control class.
-.. _`v4l2-exposure-auto-type`:
+.. _v4l2-exposure-auto-type:
``V4L2_CID_EXPOSURE_AUTO (enum v4l2_exposure_auto_type)``
Enables automatic adjustments of the exposure time and/or iris
@@ -2849,7 +2849,7 @@ Camera Control IDs
light at the image sensor. The camera performs the exposure
compensation by adjusting absolute exposure time and/or aperture.
-.. _`v4l2-exposure-metering`:
+.. _v4l2-exposure-metering:
``V4L2_CID_EXPOSURE_METERING (enum v4l2_exposure_metering)``
Determines how the camera measures the amount of light available for
@@ -2954,7 +2954,7 @@ Camera Control IDs
disabled, that is when ``V4L2_CID_FOCUS_AUTO`` control is set to
``FALSE`` (0).
-.. _`v4l2-auto-focus-status`:
+.. _v4l2-auto-focus-status:
``V4L2_CID_AUTO_FOCUS_STATUS (bitmask)``
The automatic focus status. This is a read-only control.
@@ -2997,7 +2997,7 @@ Camera Control IDs
-.. _`v4l2-auto-focus-range`:
+.. _v4l2-auto-focus-range:
``V4L2_CID_AUTO_FOCUS_RANGE (enum v4l2_auto_focus_range)``
Determines auto focus distance range for which lens may be adjusted.
@@ -3081,7 +3081,7 @@ Camera Control IDs
its strength. Such band-stop filters can be used, for example, to
filter out the fluorescent light component.
-.. _`v4l2-auto-n-preset-white-balance`:
+.. _v4l2-auto-n-preset-white-balance:
``V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE (enum v4l2_auto_n_preset_white_balance)``
Sets white balance to automatic, manual or a preset. The presets
@@ -3170,7 +3170,7 @@ Camera Control IDs
-.. _`v4l2-wide-dynamic-range`:
+.. _v4l2-wide-dynamic-range:
``V4L2_CID_WIDE_DYNAMIC_RANGE (boolean)``
Enables or disables the camera's wide dynamic range feature. This
@@ -3180,7 +3180,7 @@ Camera Control IDs
commonly realized in cameras by combining two subsequent frames with
different exposure times. [1]_
-.. _`v4l2-image-stabilization`:
+.. _v4l2-image-stabilization:
``V4L2_CID_IMAGE_STABILIZATION (boolean)``
Enables or disables image stabilization.
@@ -3198,7 +3198,7 @@ Camera Control IDs
than ``V4L2_CID_ISO_SENSITIVITY_MANUAL`` is undefined, drivers
should ignore such requests.
-.. _`v4l2-iso-sensitivity-auto-type`:
+.. _v4l2-iso-sensitivity-auto-type:
``V4L2_CID_ISO_SENSITIVITY_AUTO (enum v4l2_iso_sensitivity_type)``
Enables or disables automatic ISO sensitivity adjustments.
@@ -3224,7 +3224,7 @@ Camera Control IDs
-.. _`v4l2-scene-mode`:
+.. _v4l2-scene-mode:
``V4L2_CID_SCENE_MODE (enum v4l2_scene_mode)``
This control allows to select scene programs as the camera automatic
@@ -3936,7 +3936,7 @@ JPEG Control IDs
``V4L2_CID_JPEG_RESTART_INTERVAL`` control is set to 0, DRI and RSTm
markers will not be inserted.
-.. _`jpeg-quality-control`:
+.. _jpeg-quality-control:
``V4L2_CID_JPEG_COMPRESSION_QUALITY (integer)``
``V4L2_CID_JPEG_COMPRESSION_QUALITY`` control determines trade-off
@@ -3952,7 +3952,7 @@ JPEG Control IDs
non-zero values are meaningful. The recommended range is 1 - 100,
where larger values correspond to better image quality.
-.. _`jpeg-active-marker-control`:
+.. _jpeg-active-marker-control:
``V4L2_CID_JPEG_ACTIVE_MARKER (bitmask)``
Specify which JPEG markers are included in compressed stream. This
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-013.rst b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
index eefbd83766eb..475f6e6fe785 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-013.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-013.rst
@@ -21,7 +21,7 @@ Compressed Formats
- Details
- - .. _`V4L2-PIX-FMT-JPEG`:
+ - .. _V4L2-PIX-FMT-JPEG:
- ``V4L2_PIX_FMT_JPEG``
@@ -30,7 +30,7 @@ Compressed Formats
- TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`,
:ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`.
- - .. _`V4L2-PIX-FMT-MPEG`:
+ - .. _V4L2-PIX-FMT-MPEG:
- ``V4L2_PIX_FMT_MPEG``
@@ -40,7 +40,7 @@ Compressed Formats
extended control ``V4L2_CID_MPEG_STREAM_TYPE``, see
:ref:`mpeg-control-id`.
- - .. _`V4L2-PIX-FMT-H264`:
+ - .. _V4L2-PIX-FMT-H264:
- ``V4L2_PIX_FMT_H264``
@@ -48,7 +48,7 @@ Compressed Formats
- H264 video elementary stream with start codes.
- - .. _`V4L2-PIX-FMT-H264-NO-SC`:
+ - .. _V4L2-PIX-FMT-H264-NO-SC:
- ``V4L2_PIX_FMT_H264_NO_SC``
@@ -56,7 +56,7 @@ Compressed Formats
- H264 video elementary stream without start codes.
- - .. _`V4L2-PIX-FMT-H264-MVC`:
+ - .. _V4L2-PIX-FMT-H264-MVC:
- ``V4L2_PIX_FMT_H264_MVC``
@@ -64,7 +64,7 @@ Compressed Formats
- H264 MVC video elementary stream.
- - .. _`V4L2-PIX-FMT-H263`:
+ - .. _V4L2-PIX-FMT-H263:
- ``V4L2_PIX_FMT_H263``
@@ -72,7 +72,7 @@ Compressed Formats
- H263 video elementary stream.
- - .. _`V4L2-PIX-FMT-MPEG1`:
+ - .. _V4L2-PIX-FMT-MPEG1:
- ``V4L2_PIX_FMT_MPEG1``
@@ -80,7 +80,7 @@ Compressed Formats
- MPEG1 video elementary stream.
- - .. _`V4L2-PIX-FMT-MPEG2`:
+ - .. _V4L2-PIX-FMT-MPEG2:
- ``V4L2_PIX_FMT_MPEG2``
@@ -88,7 +88,7 @@ Compressed Formats
- MPEG2 video elementary stream.
- - .. _`V4L2-PIX-FMT-MPEG4`:
+ - .. _V4L2-PIX-FMT-MPEG4:
- ``V4L2_PIX_FMT_MPEG4``
@@ -96,7 +96,7 @@ Compressed Formats
- MPEG4 video elementary stream.
- - .. _`V4L2-PIX-FMT-XVID`:
+ - .. _V4L2-PIX-FMT-XVID:
- ``V4L2_PIX_FMT_XVID``
@@ -104,7 +104,7 @@ Compressed Formats
- Xvid video elementary stream.
- - .. _`V4L2-PIX-FMT-VC1-ANNEX-G`:
+ - .. _V4L2-PIX-FMT-VC1-ANNEX-G:
- ``V4L2_PIX_FMT_VC1_ANNEX_G``
@@ -112,7 +112,7 @@ Compressed Formats
- VC1, SMPTE 421M Annex G compliant stream.
- - .. _`V4L2-PIX-FMT-VC1-ANNEX-L`:
+ - .. _V4L2-PIX-FMT-VC1-ANNEX-L:
- ``V4L2_PIX_FMT_VC1_ANNEX_L``
@@ -120,7 +120,7 @@ Compressed Formats
- VC1, SMPTE 421M Annex L compliant stream.
- - .. _`V4L2-PIX-FMT-VP8`:
+ - .. _V4L2-PIX-FMT-VP8:
- ``V4L2_PIX_FMT_VP8``
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst b/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst
index 71e5fb316768..99a780fe6b61 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-indexed.rst
@@ -49,7 +49,7 @@ the palette, this must be done with ioctls of the Linux framebuffer API.
- 0
- - .. _`V4L2-PIX-FMT-PAL8`:
+ - .. _V4L2-PIX-FMT-PAL8:
- ``V4L2_PIX_FMT_PAL8``
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst b/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
index 37d41660fc76..c7aa2e91ac78 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst
@@ -115,7 +115,7 @@ next to each other in memory.
- 0
- - .. _`V4L2-PIX-FMT-RGB332`:
+ - .. _V4L2-PIX-FMT-RGB332:
- ``V4L2_PIX_FMT_RGB332``
@@ -138,7 +138,7 @@ next to each other in memory.
- b\ :sub:`0`
- - .. _`V4L2-PIX-FMT-ARGB444`:
+ - .. _V4L2-PIX-FMT-ARGB444:
- ``V4L2_PIX_FMT_ARGB444``
@@ -178,7 +178,7 @@ next to each other in memory.
- r\ :sub:`0`
- - .. _`V4L2-PIX-FMT-XRGB444`:
+ - .. _V4L2-PIX-FMT-XRGB444:
- ``V4L2_PIX_FMT_XRGB444``
@@ -218,7 +218,7 @@ next to each other in memory.
- r\ :sub:`0`
- - .. _`V4L2-PIX-FMT-ARGB555`:
+ - .. _V4L2-PIX-FMT-ARGB555:
- ``V4L2_PIX_FMT_ARGB555``
@@ -258,7 +258,7 @@ next to each other in memory.
- g\ :sub:`3`
- - .. _`V4L2-PIX-FMT-XRGB555`:
+ - .. _V4L2-PIX-FMT-XRGB555:
- ``V4L2_PIX_FMT_XRGB555``
@@ -298,7 +298,7 @@ next to each other in memory.
- g\ :sub:`3`
- - .. _`V4L2-PIX-FMT-RGB565`:
+ - .. _V4L2-PIX-FMT-RGB565:
- ``V4L2_PIX_FMT_RGB565``
@@ -338,7 +338,7 @@ next to each other in memory.
- g\ :sub:`3`
- - .. _`V4L2-PIX-FMT-ARGB555X`:
+ - .. _V4L2-PIX-FMT-ARGB555X:
- ``V4L2_PIX_FMT_ARGB555X``
@@ -378,7 +378,7 @@ next to each other in memory.
- b\ :sub:`0`
- - .. _`V4L2-PIX-FMT-XRGB555X`:
+ - .. _V4L2-PIX-FMT-XRGB555X:
- ``V4L2_PIX_FMT_XRGB555X``
@@ -418,7 +418,7 @@ next to each other in memory.
- b\ :sub:`0`
- - .. _`V4L2-PIX-FMT-RGB565X`:
+ - .. _V4L2-PIX-FMT-RGB565X:
- ``V4L2_PIX_FMT_RGB565X``
@@ -458,7 +458,7 @@ next to each other in memory.
- b\ :sub:`0`
- - .. _`V4L2-PIX-FMT-BGR24`:
+ - .. _V4L2-PIX-FMT-BGR24:
- ``V4L2_PIX_FMT_BGR24``
@@ -515,7 +515,7 @@ next to each other in memory.
- r\ :sub:`0`
- - .. _`V4L2-PIX-FMT-RGB24`:
+ - .. _V4L2-PIX-FMT-RGB24:
- ``V4L2_PIX_FMT_RGB24``
@@ -572,7 +572,7 @@ next to each other in memory.
- b\ :sub:`0`
- - .. _`V4L2-PIX-FMT-BGR666`:
+ - .. _V4L2-PIX-FMT-BGR666:
- ``V4L2_PIX_FMT_BGR666``
@@ -646,7 +646,7 @@ next to each other in memory.
- -
- - .. _`V4L2-PIX-FMT-ABGR32`:
+ - .. _V4L2-PIX-FMT-ABGR32:
- ``V4L2_PIX_FMT_ABGR32``
@@ -720,7 +720,7 @@ next to each other in memory.
- a\ :sub:`0`
- - .. _`V4L2-PIX-FMT-XBGR32`:
+ - .. _V4L2-PIX-FMT-XBGR32:
- ``V4L2_PIX_FMT_XBGR32``
@@ -794,7 +794,7 @@ next to each other in memory.
- -
- - .. _`V4L2-PIX-FMT-ARGB32`:
+ - .. _V4L2-PIX-FMT-ARGB32:
- ``V4L2_PIX_FMT_ARGB32``
@@ -868,7 +868,7 @@ next to each other in memory.
- b\ :sub:`0`
- - .. _`V4L2-PIX-FMT-XRGB32`:
+ - .. _V4L2-PIX-FMT-XRGB32:
- ``V4L2_PIX_FMT_XRGB32``
@@ -1194,7 +1194,7 @@ either the corresponding ARGB or XRGB format, depending on the driver.
- 0
- - .. _`V4L2-PIX-FMT-RGB444`:
+ - .. _V4L2-PIX-FMT-RGB444:
- ``V4L2_PIX_FMT_RGB444``
@@ -1234,7 +1234,7 @@ either the corresponding ARGB or XRGB format, depending on the driver.
- r\ :sub:`0`
- - .. _`V4L2-PIX-FMT-RGB555`:
+ - .. _V4L2-PIX-FMT-RGB555:
- ``V4L2_PIX_FMT_RGB555``
@@ -1274,7 +1274,7 @@ either the corresponding ARGB or XRGB format, depending on the driver.
- g\ :sub:`3`
- - .. _`V4L2-PIX-FMT-RGB555X`:
+ - .. _V4L2-PIX-FMT-RGB555X:
- ``V4L2_PIX_FMT_RGB555X``
@@ -1314,7 +1314,7 @@ either the corresponding ARGB or XRGB format, depending on the driver.
- b\ :sub:`0`
- - .. _`V4L2-PIX-FMT-BGR32`:
+ - .. _V4L2-PIX-FMT-BGR32:
- ``V4L2_PIX_FMT_BGR32``
@@ -1388,7 +1388,7 @@ either the corresponding ARGB or XRGB format, depending on the driver.
- a\ :sub:`0`
- - .. _`V4L2-PIX-FMT-RGB32`:
+ - .. _V4L2-PIX-FMT-RGB32:
- ``V4L2_PIX_FMT_RGB32``
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst b/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst
index 2560257237dc..54716455f453 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst
@@ -115,7 +115,7 @@ component of each pixel in one 16 or 32 bit word.
- 0
- - .. _`V4L2-PIX-FMT-YUV444`:
+ - .. _V4L2-PIX-FMT-YUV444:
- ``V4L2_PIX_FMT_YUV444``
@@ -155,7 +155,7 @@ component of each pixel in one 16 or 32 bit word.
- Y'\ :sub:`0`
- - .. _`V4L2-PIX-FMT-YUV555`:
+ - .. _V4L2-PIX-FMT-YUV555:
- ``V4L2_PIX_FMT_YUV555``
@@ -195,7 +195,7 @@ component of each pixel in one 16 or 32 bit word.
- Cb\ :sub:`3`
- - .. _`V4L2-PIX-FMT-YUV565`:
+ - .. _V4L2-PIX-FMT-YUV565:
- ``V4L2_PIX_FMT_YUV565``
@@ -235,7 +235,7 @@ component of each pixel in one 16 or 32 bit word.
- Cb\ :sub:`3`
- - .. _`V4L2-PIX-FMT-YUV32`:
+ - .. _V4L2-PIX-FMT-YUV32:
- ``V4L2_PIX_FMT_YUV32``
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst b/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst
index 8f9ecae1e677..9a5704baf9fe 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-reserved.rst
@@ -33,7 +33,7 @@ please make a proposal on the linux-media mailing list.
- Details
- - .. _`V4L2-PIX-FMT-DV`:
+ - .. _V4L2-PIX-FMT-DV:
- ``V4L2_PIX_FMT_DV``
@@ -41,7 +41,7 @@ please make a proposal on the linux-media mailing list.
- unknown
- - .. _`V4L2-PIX-FMT-ET61X251`:
+ - .. _V4L2-PIX-FMT-ET61X251:
- ``V4L2_PIX_FMT_ET61X251``
@@ -49,7 +49,7 @@ please make a proposal on the linux-media mailing list.
- Compressed format of the ET61X251 driver.
- - .. _`V4L2-PIX-FMT-HI240`:
+ - .. _V4L2-PIX-FMT-HI240:
- ``V4L2_PIX_FMT_HI240``
@@ -57,7 +57,7 @@ please make a proposal on the linux-media mailing list.
- 8 bit RGB format used by the BTTV driver.
- - .. _`V4L2-PIX-FMT-HM12`:
+ - .. _V4L2-PIX-FMT-HM12:
- ``V4L2_PIX_FMT_HM12``
@@ -69,7 +69,7 @@ please make a proposal on the linux-media mailing list.
The format is documented in the kernel sources in the file
``Documentation/video4linux/cx2341x/README.hm12``
- - .. _`V4L2-PIX-FMT-CPIA1`:
+ - .. _V4L2-PIX-FMT-CPIA1:
- ``V4L2_PIX_FMT_CPIA1``
@@ -77,7 +77,7 @@ please make a proposal on the linux-media mailing list.
- YUV format used by the gspca cpia1 driver.
- - .. _`V4L2-PIX-FMT-JPGL`:
+ - .. _V4L2-PIX-FMT-JPGL:
- ``V4L2_PIX_FMT_JPGL``
@@ -86,7 +86,7 @@ please make a proposal on the linux-media mailing list.
- JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
80x.
- - .. _`V4L2-PIX-FMT-SPCA501`:
+ - .. _V4L2-PIX-FMT-SPCA501:
- ``V4L2_PIX_FMT_SPCA501``
@@ -94,7 +94,7 @@ please make a proposal on the linux-media mailing list.
- YUYV per line used by the gspca driver.
- - .. _`V4L2-PIX-FMT-SPCA505`:
+ - .. _V4L2-PIX-FMT-SPCA505:
- ``V4L2_PIX_FMT_SPCA505``
@@ -102,7 +102,7 @@ please make a proposal on the linux-media mailing list.
- YYUV per line used by the gspca driver.
- - .. _`V4L2-PIX-FMT-SPCA508`:
+ - .. _V4L2-PIX-FMT-SPCA508:
- ``V4L2_PIX_FMT_SPCA508``
@@ -110,7 +110,7 @@ please make a proposal on the linux-media mailing list.
- YUVY per line used by the gspca driver.
- - .. _`V4L2-PIX-FMT-SPCA561`:
+ - .. _V4L2-PIX-FMT-SPCA561:
- ``V4L2_PIX_FMT_SPCA561``
@@ -118,7 +118,7 @@ please make a proposal on the linux-media mailing list.
- Compressed GBRG Bayer format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-PAC207`:
+ - .. _V4L2-PIX-FMT-PAC207:
- ``V4L2_PIX_FMT_PAC207``
@@ -126,7 +126,7 @@ please make a proposal on the linux-media mailing list.
- Compressed BGGR Bayer format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-MR97310A`:
+ - .. _V4L2-PIX-FMT-MR97310A:
- ``V4L2_PIX_FMT_MR97310A``
@@ -134,7 +134,7 @@ please make a proposal on the linux-media mailing list.
- Compressed BGGR Bayer format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-JL2005BCD`:
+ - .. _V4L2-PIX-FMT-JL2005BCD:
- ``V4L2_PIX_FMT_JL2005BCD``
@@ -142,7 +142,7 @@ please make a proposal on the linux-media mailing list.
- JPEG compressed RGGB Bayer format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-OV511`:
+ - .. _V4L2-PIX-FMT-OV511:
- ``V4L2_PIX_FMT_OV511``
@@ -150,7 +150,7 @@ please make a proposal on the linux-media mailing list.
- OV511 JPEG format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-OV518`:
+ - .. _V4L2-PIX-FMT-OV518:
- ``V4L2_PIX_FMT_OV518``
@@ -158,7 +158,7 @@ please make a proposal on the linux-media mailing list.
- OV518 JPEG format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-PJPG`:
+ - .. _V4L2-PIX-FMT-PJPG:
- ``V4L2_PIX_FMT_PJPG``
@@ -166,7 +166,7 @@ please make a proposal on the linux-media mailing list.
- Pixart 73xx JPEG format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-SE401`:
+ - .. _V4L2-PIX-FMT-SE401:
- ``V4L2_PIX_FMT_SE401``
@@ -174,7 +174,7 @@ please make a proposal on the linux-media mailing list.
- Compressed RGB format used by the gspca se401 driver
- - .. _`V4L2-PIX-FMT-SQ905C`:
+ - .. _V4L2-PIX-FMT-SQ905C:
- ``V4L2_PIX_FMT_SQ905C``
@@ -182,7 +182,7 @@ please make a proposal on the linux-media mailing list.
- Compressed RGGB bayer format used by the gspca driver.
- - .. _`V4L2-PIX-FMT-MJPEG`:
+ - .. _V4L2-PIX-FMT-MJPEG:
- ``V4L2_PIX_FMT_MJPEG``
@@ -190,7 +190,7 @@ please make a proposal on the linux-media mailing list.
- Compressed format used by the Zoran driver
- - .. _`V4L2-PIX-FMT-PWC1`:
+ - .. _V4L2-PIX-FMT-PWC1:
- ``V4L2_PIX_FMT_PWC1``
@@ -198,7 +198,7 @@ please make a proposal on the linux-media mailing list.
- Compressed format of the PWC driver.
- - .. _`V4L2-PIX-FMT-PWC2`:
+ - .. _V4L2-PIX-FMT-PWC2:
- ``V4L2_PIX_FMT_PWC2``
@@ -206,7 +206,7 @@ please make a proposal on the linux-media mailing list.
- Compressed format of the PWC driver.
- - .. _`V4L2-PIX-FMT-SN9C10X`:
+ - .. _V4L2-PIX-FMT-SN9C10X:
- ``V4L2_PIX_FMT_SN9C10X``
@@ -214,7 +214,7 @@ please make a proposal on the linux-media mailing list.
- Compressed format of the SN9C102 driver.
- - .. _`V4L2-PIX-FMT-SN9C20X-I420`:
+ - .. _V4L2-PIX-FMT-SN9C20X-I420:
- ``V4L2_PIX_FMT_SN9C20X_I420``
@@ -222,7 +222,7 @@ please make a proposal on the linux-media mailing list.
- YUV 4:2:0 format of the gspca sn9c20x driver.
- - .. _`V4L2-PIX-FMT-SN9C2028`:
+ - .. _V4L2-PIX-FMT-SN9C2028:
- ``V4L2_PIX_FMT_SN9C2028``
@@ -230,7 +230,7 @@ please make a proposal on the linux-media mailing list.
- Compressed GBRG bayer format of the gspca sn9c2028 driver.
- - .. _`V4L2-PIX-FMT-STV0680`:
+ - .. _V4L2-PIX-FMT-STV0680:
- ``V4L2_PIX_FMT_STV0680``
@@ -238,7 +238,7 @@ please make a proposal on the linux-media mailing list.
- Bayer format of the gspca stv0680 driver.
- - .. _`V4L2-PIX-FMT-WNVA`:
+ - .. _V4L2-PIX-FMT-WNVA:
- ``V4L2_PIX_FMT_WNVA``
@@ -247,7 +247,7 @@ please make a proposal on the linux-media mailing list.
- Used by the Winnov Videum driver,
`http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
- - .. _`V4L2-PIX-FMT-TM6000`:
+ - .. _V4L2-PIX-FMT-TM6000:
- ``V4L2_PIX_FMT_TM6000``
@@ -255,7 +255,7 @@ please make a proposal on the linux-media mailing list.
- Used by Trident tm6000
- - .. _`V4L2-PIX-FMT-CIT-YYVYUY`:
+ - .. _V4L2-PIX-FMT-CIT-YYVYUY:
- ``V4L2_PIX_FMT_CIT_YYVYUY``
@@ -265,7 +265,7 @@ please make a proposal on the linux-media mailing list.
Uses one line of Y then 1 line of VYUY
- - .. _`V4L2-PIX-FMT-KONICA420`:
+ - .. _V4L2-PIX-FMT-KONICA420:
- ``V4L2_PIX_FMT_KONICA420``
@@ -275,7 +275,7 @@ please make a proposal on the linux-media mailing list.
YUV420 planar in blocks of 256 pixels.
- - .. _`V4L2-PIX-FMT-YYUV`:
+ - .. _V4L2-PIX-FMT-YYUV:
- ``V4L2_PIX_FMT_YYUV``
@@ -283,7 +283,7 @@ please make a proposal on the linux-media mailing list.
- unknown
- - .. _`V4L2-PIX-FMT-Y4`:
+ - .. _V4L2-PIX-FMT-Y4:
- ``V4L2_PIX_FMT_Y4``
@@ -292,7 +292,7 @@ please make a proposal on the linux-media mailing list.
- Old 4-bit greyscale format. Only the most significant 4 bits of
each byte are used, the other bits are set to 0.
- - .. _`V4L2-PIX-FMT-Y6`:
+ - .. _V4L2-PIX-FMT-Y6:
- ``V4L2_PIX_FMT_Y6``
@@ -301,7 +301,7 @@ please make a proposal on the linux-media mailing list.
- Old 6-bit greyscale format. Only the most significant 6 bits of
each byte are used, the other bits are set to 0.
- - .. _`V4L2-PIX-FMT-S5C-UYVY-JPG`:
+ - .. _V4L2-PIX-FMT-S5C-UYVY-JPG:
- ``V4L2_PIX_FMT_S5C_UYVY_JPG``
diff --git a/Documentation/linux_tv/media/v4l/subdev-formats.rst b/Documentation/linux_tv/media/v4l/subdev-formats.rst
index cf4be8cab3f9..6dbb27b09c34 100644
--- a/Documentation/linux_tv/media/v4l/subdev-formats.rst
+++ b/Documentation/linux_tv/media/v4l/subdev-formats.rst
@@ -240,7 +240,7 @@ The following tables list existing packed RGB formats.
- 0
- - .. _`MEDIA-BUS-FMT-RGB444-1X12`:
+ - .. _MEDIA-BUS-FMT-RGB444-1X12:
- MEDIA_BUS_FMT_RGB444_1X12
@@ -311,7 +311,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB444-2X8-PADHI-BE`:
+ - .. _MEDIA-BUS-FMT-RGB444-2X8-PADHI-BE:
- MEDIA_BUS_FMT_RGB444_2X8_PADHI_BE
@@ -451,7 +451,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB444-2X8-PADHI-LE`:
+ - .. _MEDIA-BUS-FMT-RGB444-2X8-PADHI-LE:
- MEDIA_BUS_FMT_RGB444_2X8_PADHI_LE
@@ -591,7 +591,7 @@ The following tables list existing packed RGB formats.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB555-2X8-PADHI-BE`:
+ - .. _MEDIA-BUS-FMT-RGB555-2X8-PADHI-BE:
- MEDIA_BUS_FMT_RGB555_2X8_PADHI_BE
@@ -731,7 +731,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB555-2X8-PADHI-LE`:
+ - .. _MEDIA-BUS-FMT-RGB555-2X8-PADHI-LE:
- MEDIA_BUS_FMT_RGB555_2X8_PADHI_LE
@@ -871,7 +871,7 @@ The following tables list existing packed RGB formats.
- g\ :sub:`3`
- - .. _`MEDIA-BUS-FMT-RGB565-1X16`:
+ - .. _MEDIA-BUS-FMT-RGB565-1X16:
- MEDIA_BUS_FMT_RGB565_1X16
@@ -942,7 +942,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-BGR565-2X8-BE`:
+ - .. _MEDIA-BUS-FMT-BGR565-2X8-BE:
- MEDIA_BUS_FMT_BGR565_2X8_BE
@@ -1082,7 +1082,7 @@ The following tables list existing packed RGB formats.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-BGR565-2X8-LE`:
+ - .. _MEDIA-BUS-FMT-BGR565-2X8-LE:
- MEDIA_BUS_FMT_BGR565_2X8_LE
@@ -1222,7 +1222,7 @@ The following tables list existing packed RGB formats.
- g\ :sub:`3`
- - .. _`MEDIA-BUS-FMT-RGB565-2X8-BE`:
+ - .. _MEDIA-BUS-FMT-RGB565-2X8-BE:
- MEDIA_BUS_FMT_RGB565_2X8_BE
@@ -1362,7 +1362,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB565-2X8-LE`:
+ - .. _MEDIA-BUS-FMT-RGB565-2X8-LE:
- MEDIA_BUS_FMT_RGB565_2X8_LE
@@ -1502,7 +1502,7 @@ The following tables list existing packed RGB formats.
- g\ :sub:`3`
- - .. _`MEDIA-BUS-FMT-RGB666-1X18`:
+ - .. _MEDIA-BUS-FMT-RGB666-1X18:
- MEDIA_BUS_FMT_RGB666_1X18
@@ -1573,7 +1573,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RBG888-1X24`:
+ - .. _MEDIA-BUS-FMT-RBG888-1X24:
- MEDIA_BUS_FMT_RBG888_1X24
@@ -1644,7 +1644,7 @@ The following tables list existing packed RGB formats.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB666-1X24_CPADHI`:
+ - .. _MEDIA-BUS-FMT-RGB666-1X24_CPADHI:
- MEDIA_BUS_FMT_RGB666_1X24_CPADHI
@@ -1715,7 +1715,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-BGR888-1X24`:
+ - .. _MEDIA-BUS-FMT-BGR888-1X24:
- MEDIA_BUS_FMT_BGR888_1X24
@@ -1786,7 +1786,7 @@ The following tables list existing packed RGB formats.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-GBR888-1X24`:
+ - .. _MEDIA-BUS-FMT-GBR888-1X24:
- MEDIA_BUS_FMT_GBR888_1X24
@@ -1857,7 +1857,7 @@ The following tables list existing packed RGB formats.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB888-1X24`:
+ - .. _MEDIA-BUS-FMT-RGB888-1X24:
- MEDIA_BUS_FMT_RGB888_1X24
@@ -1928,7 +1928,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB888-2X12-BE`:
+ - .. _MEDIA-BUS-FMT-RGB888-2X12-BE:
- MEDIA_BUS_FMT_RGB888_2X12_BE
@@ -2068,7 +2068,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB888-2X12-LE`:
+ - .. _MEDIA-BUS-FMT-RGB888-2X12-LE:
- MEDIA_BUS_FMT_RGB888_2X12_LE
@@ -2208,7 +2208,7 @@ The following tables list existing packed RGB formats.
- g\ :sub:`4`
- - .. _`MEDIA-BUS-FMT-ARGB888-1X32`:
+ - .. _MEDIA-BUS-FMT-ARGB888-1X32:
- MEDIA_BUS_FMT_ARGB888_1X32
@@ -2279,7 +2279,7 @@ The following tables list existing packed RGB formats.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB888-1X32-PADHI`:
+ - .. _MEDIA-BUS-FMT-RGB888-1X32-PADHI:
- MEDIA_BUS_FMT_RGB888_1X32_PADHI
@@ -2393,7 +2393,7 @@ JEIDA defined bit mapping will be named
- 0
- - .. _`MEDIA-BUS-FMT-RGB666-1X7X3-SPWG`:
+ - .. _MEDIA-BUS-FMT-RGB666-1X7X3-SPWG:
- MEDIA_BUS_FMT_RGB666_1X7X3_SPWG
@@ -2500,7 +2500,7 @@ JEIDA defined bit mapping will be named
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB888-1X7X4-SPWG`:
+ - .. _MEDIA-BUS-FMT-RGB888-1X7X4-SPWG:
- MEDIA_BUS_FMT_RGB888_1X7X4_SPWG
@@ -2607,7 +2607,7 @@ JEIDA defined bit mapping will be named
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-RGB888-1X7X4-JEIDA`:
+ - .. _MEDIA-BUS-FMT-RGB888-1X7X4-JEIDA:
- MEDIA_BUS_FMT_RGB888_1X7X4_JEIDA
@@ -2814,7 +2814,7 @@ organization is given as an example for the first pixel only.
- 0
- - .. _`MEDIA-BUS-FMT-SBGGR8-1X8`:
+ - .. _MEDIA-BUS-FMT-SBGGR8-1X8:
- MEDIA_BUS_FMT_SBGGR8_1X8
@@ -2845,7 +2845,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGBRG8-1X8`:
+ - .. _MEDIA-BUS-FMT-SGBRG8-1X8:
- MEDIA_BUS_FMT_SGBRG8_1X8
@@ -2876,7 +2876,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGRBG8-1X8`:
+ - .. _MEDIA-BUS-FMT-SGRBG8-1X8:
- MEDIA_BUS_FMT_SGRBG8_1X8
@@ -2907,7 +2907,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SRGGB8-1X8`:
+ - .. _MEDIA-BUS-FMT-SRGGB8-1X8:
- MEDIA_BUS_FMT_SRGGB8_1X8
@@ -2938,7 +2938,7 @@ organization is given as an example for the first pixel only.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SBGGR10-ALAW8-1X8`:
+ - .. _MEDIA-BUS-FMT-SBGGR10-ALAW8-1X8:
- MEDIA_BUS_FMT_SBGGR10_ALAW8_1X8
@@ -2969,7 +2969,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGBRG10-ALAW8-1X8`:
+ - .. _MEDIA-BUS-FMT-SGBRG10-ALAW8-1X8:
- MEDIA_BUS_FMT_SGBRG10_ALAW8_1X8
@@ -3000,7 +3000,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGRBG10-ALAW8-1X8`:
+ - .. _MEDIA-BUS-FMT-SGRBG10-ALAW8-1X8:
- MEDIA_BUS_FMT_SGRBG10_ALAW8_1X8
@@ -3031,7 +3031,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SRGGB10-ALAW8-1X8`:
+ - .. _MEDIA-BUS-FMT-SRGGB10-ALAW8-1X8:
- MEDIA_BUS_FMT_SRGGB10_ALAW8_1X8
@@ -3062,7 +3062,7 @@ organization is given as an example for the first pixel only.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SBGGR10-DPCM8-1X8`:
+ - .. _MEDIA-BUS-FMT-SBGGR10-DPCM8-1X8:
- MEDIA_BUS_FMT_SBGGR10_DPCM8_1X8
@@ -3093,7 +3093,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGBRG10-DPCM8-1X8`:
+ - .. _MEDIA-BUS-FMT-SGBRG10-DPCM8-1X8:
- MEDIA_BUS_FMT_SGBRG10_DPCM8_1X8
@@ -3124,7 +3124,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGRBG10-DPCM8-1X8`:
+ - .. _MEDIA-BUS-FMT-SGRBG10-DPCM8-1X8:
- MEDIA_BUS_FMT_SGRBG10_DPCM8_1X8
@@ -3155,7 +3155,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SRGGB10-DPCM8-1X8`:
+ - .. _MEDIA-BUS-FMT-SRGGB10-DPCM8-1X8:
- MEDIA_BUS_FMT_SRGGB10_DPCM8_1X8
@@ -3186,7 +3186,7 @@ organization is given as an example for the first pixel only.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SBGGR10-2X8-PADHI-BE`:
+ - .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADHI-BE:
- MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_BE
@@ -3246,7 +3246,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SBGGR10-2X8-PADHI-LE`:
+ - .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADHI-LE:
- MEDIA_BUS_FMT_SBGGR10_2X8_PADHI_LE
@@ -3306,7 +3306,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`8`
- - .. _`MEDIA-BUS-FMT-SBGGR10-2X8-PADLO-BE`:
+ - .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADLO-BE:
- MEDIA_BUS_FMT_SBGGR10_2X8_PADLO_BE
@@ -3366,7 +3366,7 @@ organization is given as an example for the first pixel only.
- 0
- - .. _`MEDIA-BUS-FMT-SBGGR10-2X8-PADLO-LE`:
+ - .. _MEDIA-BUS-FMT-SBGGR10-2X8-PADLO-LE:
- MEDIA_BUS_FMT_SBGGR10_2X8_PADLO_LE
@@ -3426,7 +3426,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`2`
- - .. _`MEDIA-BUS-FMT-SBGGR10-1X10`:
+ - .. _MEDIA-BUS-FMT-SBGGR10-1X10:
- MEDIA_BUS_FMT_SBGGR10_1X10
@@ -3457,7 +3457,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGBRG10-1X10`:
+ - .. _MEDIA-BUS-FMT-SGBRG10-1X10:
- MEDIA_BUS_FMT_SGBRG10_1X10
@@ -3488,7 +3488,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGRBG10-1X10`:
+ - .. _MEDIA-BUS-FMT-SGRBG10-1X10:
- MEDIA_BUS_FMT_SGRBG10_1X10
@@ -3519,7 +3519,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SRGGB10-1X10`:
+ - .. _MEDIA-BUS-FMT-SRGGB10-1X10:
- MEDIA_BUS_FMT_SRGGB10_1X10
@@ -3550,7 +3550,7 @@ organization is given as an example for the first pixel only.
- r\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SBGGR12-1X12`:
+ - .. _MEDIA-BUS-FMT-SBGGR12-1X12:
- MEDIA_BUS_FMT_SBGGR12_1X12
@@ -3581,7 +3581,7 @@ organization is given as an example for the first pixel only.
- b\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGBRG12-1X12`:
+ - .. _MEDIA-BUS-FMT-SGBRG12-1X12:
- MEDIA_BUS_FMT_SGBRG12_1X12
@@ -3612,7 +3612,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SGRBG12-1X12`:
+ - .. _MEDIA-BUS-FMT-SGRBG12-1X12:
- MEDIA_BUS_FMT_SGRBG12_1X12
@@ -3643,7 +3643,7 @@ organization is given as an example for the first pixel only.
- g\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-SRGGB12-1X12`:
+ - .. _MEDIA-BUS-FMT-SRGGB12-1X12:
- MEDIA_BUS_FMT_SRGGB12_1X12
@@ -3817,7 +3817,7 @@ the following codes.
- 0
- - .. _`MEDIA-BUS-FMT-Y8-1X8`:
+ - .. _MEDIA-BUS-FMT-Y8-1X8:
- MEDIA_BUS_FMT_Y8_1X8
@@ -3888,7 +3888,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UV8-1X8`:
+ - .. _MEDIA-BUS-FMT-UV8-1X8:
- MEDIA_BUS_FMT_UV8_1X8
@@ -4028,7 +4028,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UYVY8-1_5X8`:
+ - .. _MEDIA-BUS-FMT-UYVY8-1_5X8:
- MEDIA_BUS_FMT_UYVY8_1_5X8
@@ -4444,7 +4444,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VYUY8-1_5X8`:
+ - .. _MEDIA-BUS-FMT-VYUY8-1_5X8:
- MEDIA_BUS_FMT_VYUY8_1_5X8
@@ -4860,7 +4860,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUYV8-1_5X8`:
+ - .. _MEDIA-BUS-FMT-YUYV8-1_5X8:
- MEDIA_BUS_FMT_YUYV8_1_5X8
@@ -5276,7 +5276,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YVYU8-1_5X8`:
+ - .. _MEDIA-BUS-FMT-YVYU8-1_5X8:
- MEDIA_BUS_FMT_YVYU8_1_5X8
@@ -5692,7 +5692,7 @@ the following codes.
- u\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UYVY8-2X8`:
+ - .. _MEDIA-BUS-FMT-UYVY8-2X8:
- MEDIA_BUS_FMT_UYVY8_2X8
@@ -5970,7 +5970,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VYUY8-2X8`:
+ - .. _MEDIA-BUS-FMT-VYUY8-2X8:
- MEDIA_BUS_FMT_VYUY8_2X8
@@ -6248,7 +6248,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUYV8-2X8`:
+ - .. _MEDIA-BUS-FMT-YUYV8-2X8:
- MEDIA_BUS_FMT_YUYV8_2X8
@@ -6526,7 +6526,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YVYU8-2X8`:
+ - .. _MEDIA-BUS-FMT-YVYU8-2X8:
- MEDIA_BUS_FMT_YVYU8_2X8
@@ -6804,7 +6804,7 @@ the following codes.
- u\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-Y10-1X10`:
+ - .. _MEDIA-BUS-FMT-Y10-1X10:
- MEDIA_BUS_FMT_Y10_1X10
@@ -6875,7 +6875,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UYVY10-2X10`:
+ - .. _MEDIA-BUS-FMT-UYVY10-2X10:
- MEDIA_BUS_FMT_UYVY10_2X10
@@ -7153,7 +7153,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VYUY10-2X10`:
+ - .. _MEDIA-BUS-FMT-VYUY10-2X10:
- MEDIA_BUS_FMT_VYUY10_2X10
@@ -7431,7 +7431,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUYV10-2X10`:
+ - .. _MEDIA-BUS-FMT-YUYV10-2X10:
- MEDIA_BUS_FMT_YUYV10_2X10
@@ -7709,7 +7709,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YVYU10-2X10`:
+ - .. _MEDIA-BUS-FMT-YVYU10-2X10:
- MEDIA_BUS_FMT_YVYU10_2X10
@@ -7987,7 +7987,7 @@ the following codes.
- u\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-Y12-1X12`:
+ - .. _MEDIA-BUS-FMT-Y12-1X12:
- MEDIA_BUS_FMT_Y12_1X12
@@ -8058,7 +8058,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UYVY12-2X12`:
+ - .. _MEDIA-BUS-FMT-UYVY12-2X12:
- MEDIA_BUS_FMT_UYVY12_2X12
@@ -8336,7 +8336,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VYUY12-2X12`:
+ - .. _MEDIA-BUS-FMT-VYUY12-2X12:
- MEDIA_BUS_FMT_VYUY12_2X12
@@ -8614,7 +8614,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUYV12-2X12`:
+ - .. _MEDIA-BUS-FMT-YUYV12-2X12:
- MEDIA_BUS_FMT_YUYV12_2X12
@@ -8892,7 +8892,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YVYU12-2X12`:
+ - .. _MEDIA-BUS-FMT-YVYU12-2X12:
- MEDIA_BUS_FMT_YVYU12_2X12
@@ -9170,7 +9170,7 @@ the following codes.
- u\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UYVY8-1X16`:
+ - .. _MEDIA-BUS-FMT-UYVY8-1X16:
- MEDIA_BUS_FMT_UYVY8_1X16
@@ -9310,7 +9310,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VYUY8-1X16`:
+ - .. _MEDIA-BUS-FMT-VYUY8-1X16:
- MEDIA_BUS_FMT_VYUY8_1X16
@@ -9450,7 +9450,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUYV8-1X16`:
+ - .. _MEDIA-BUS-FMT-YUYV8-1X16:
- MEDIA_BUS_FMT_YUYV8_1X16
@@ -9590,7 +9590,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YVYU8-1X16`:
+ - .. _MEDIA-BUS-FMT-YVYU8-1X16:
- MEDIA_BUS_FMT_YVYU8_1X16
@@ -9730,7 +9730,7 @@ the following codes.
- u\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YDYUYDYV8-1X16`:
+ - .. _MEDIA-BUS-FMT-YDYUYDYV8-1X16:
- MEDIA_BUS_FMT_YDYUYDYV8_1X16
@@ -10008,7 +10008,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UYVY10-1X20`:
+ - .. _MEDIA-BUS-FMT-UYVY10-1X20:
- MEDIA_BUS_FMT_UYVY10_1X20
@@ -10148,7 +10148,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VYUY10-1X20`:
+ - .. _MEDIA-BUS-FMT-VYUY10-1X20:
- MEDIA_BUS_FMT_VYUY10_1X20
@@ -10288,7 +10288,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUYV10-1X20`:
+ - .. _MEDIA-BUS-FMT-YUYV10-1X20:
- MEDIA_BUS_FMT_YUYV10_1X20
@@ -10428,7 +10428,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YVYU10-1X20`:
+ - .. _MEDIA-BUS-FMT-YVYU10-1X20:
- MEDIA_BUS_FMT_YVYU10_1X20
@@ -10568,7 +10568,7 @@ the following codes.
- u\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VUY8-1X24`:
+ - .. _MEDIA-BUS-FMT-VUY8-1X24:
- MEDIA_BUS_FMT_VUY8_1X24
@@ -10639,7 +10639,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUV8-1X24`:
+ - .. _MEDIA-BUS-FMT-YUV8-1X24:
- MEDIA_BUS_FMT_YUV8_1X24
@@ -10710,7 +10710,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-UYVY12-1X24`:
+ - .. _MEDIA-BUS-FMT-UYVY12-1X24:
- MEDIA_BUS_FMT_UYVY12_1X24
@@ -10850,7 +10850,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-VYUY12-1X24`:
+ - .. _MEDIA-BUS-FMT-VYUY12-1X24:
- MEDIA_BUS_FMT_VYUY12_1X24
@@ -10990,7 +10990,7 @@ the following codes.
- y\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUYV12-1X24`:
+ - .. _MEDIA-BUS-FMT-YUYV12-1X24:
- MEDIA_BUS_FMT_YUYV12_1X24
@@ -11130,7 +11130,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YVYU12-1X24`:
+ - .. _MEDIA-BUS-FMT-YVYU12-1X24:
- MEDIA_BUS_FMT_YVYU12_1X24
@@ -11270,7 +11270,7 @@ the following codes.
- u\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-YUV10-1X30`:
+ - .. _MEDIA-BUS-FMT-YUV10-1X30:
- MEDIA_BUS_FMT_YUV10_1X30
@@ -11341,7 +11341,7 @@ the following codes.
- v\ :sub:`0`
- - .. _`MEDIA-BUS-FMT-AYUV8-1X32`:
+ - .. _MEDIA-BUS-FMT-AYUV8-1X32:
- MEDIA_BUS_FMT_AYUV8_1X32
@@ -11534,7 +11534,7 @@ The following table lists existing HSV/HSL formats.
- 0
- - .. _`MEDIA-BUS-FMT-AHSV8888-1X32`:
+ - .. _MEDIA-BUS-FMT-AHSV8888-1X32:
- MEDIA_BUS_FMT_AHSV8888_1X32
@@ -11639,7 +11639,7 @@ The following table lists existing JPEG compressed formats.
- Remarks
- - .. _`MEDIA-BUS-FMT-JPEG-1X8`:
+ - .. _MEDIA-BUS-FMT-JPEG-1X8:
- MEDIA_BUS_FMT_JPEG_1X8
@@ -11678,7 +11678,7 @@ formats.
- Comments
- - .. _`MEDIA-BUS-FMT-S5C-UYVY-JPEG-1X8`:
+ - .. _MEDIA-BUS-FMT-S5C-UYVY-JPEG-1X8:
- MEDIA_BUS_FMT_S5C_UYVY_JPEG_1X8
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 47/54] doc-rst: linux_tv: Don't ignore pix formats
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (45 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 46/54] doc-rst: fix some badly converted references Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 48/54] doc-rst: videodev2.h: don't ignore V4L2_STD macros Mauro Carvalho Chehab
` (7 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Now that the reference problems were solved, let's not
ignore anymore the pix formats, as all of them are already
documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/media/v4l/pixfmt-nv12.rst | 1 +
Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst | 2 +
Documentation/linux_tv/media/v4l/pixfmt-nv16.rst | 1 +
Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst | 1 +
Documentation/linux_tv/media/v4l/pixfmt-nv24.rst | 1 +
.../linux_tv/media/v4l/pixfmt-sdr-cs08.rst | 2 +-
.../linux_tv/media/v4l/pixfmt-sdr-cu08.rst | 2 +-
.../linux_tv/media/v4l/pixfmt-srggb10.rst | 3 +
.../linux_tv/media/v4l/pixfmt-srggb10alaw8.rst | 3 +
.../linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst | 4 +
.../linux_tv/media/v4l/pixfmt-srggb10p.rst | 3 +
.../linux_tv/media/v4l/pixfmt-srggb12.rst | 4 +
Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst | 1 +
.../linux_tv/media/v4l/pixfmt-yuv420m.rst | 1 +
.../linux_tv/media/v4l/pixfmt-yuv422m.rst | 1 +
.../linux_tv/media/v4l/pixfmt-yuv444m.rst | 1 +
Documentation/linux_tv/videodev2.h.rst.exceptions | 142 ---------------------
17 files changed, 29 insertions(+), 144 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
index 65ccfb837318..cf59b28f75b7 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv12.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-NV12:
+.. _V4L2-PIX-FMT-NV21:
******************************************************
V4L2_PIX_FMT_NV12 ('NV12'), V4L2_PIX_FMT_NV21 ('NV21')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
index f0e0af732949..a4e7eaeccea8 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst
@@ -1,6 +1,8 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-NV12M:
+.. _v4l2-pix-fmt-nv12mt-16x16:
+.. _V4L2-PIX-FMT-NV21M:
***********************************************************************************
V4L2_PIX_FMT_NV12M ('NM12'), V4L2_PIX_FMT_NV21M ('NM21'), V4L2_PIX_FMT_NV12MT_16X16
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst
index 5a7e89529ce9..88aa7617f7cf 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv16.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-NV16:
+.. _V4L2-PIX-FMT-NV61:
******************************************************
V4L2_PIX_FMT_NV16 ('NV16'), V4L2_PIX_FMT_NV61 ('NV61')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst
index 9b4c5b09c4b5..b7ee068f491c 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-NV16M:
+.. _v4l2-pix-fmt-nv61m:
********************************************************
V4L2_PIX_FMT_NV16M ('NM16'), V4L2_PIX_FMT_NV61M ('NM61')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst b/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst
index 3f07f9391205..db98f476446e 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-nv24.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-NV24:
+.. _V4L2-PIX-FMT-NV42:
******************************************************
V4L2_PIX_FMT_NV24 ('NV24'), V4L2_PIX_FMT_NV42 ('NV42')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst
index a772b6a674d5..2736275d080f 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _V4L2-SDR-FMT-CS08:
+.. _v4l2-sdr-fmt-cs8:
*************************
V4L2_SDR_FMT_CS8 ('CS08')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst
index 9ea92099e7ed..68ad1717f6d7 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst
@@ -1,6 +1,6 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _V4L2-SDR-FMT-CU08:
+.. _v4l2-sdr-fmt-cu8:
*************************
V4L2_SDR_FMT_CU8 ('CU08')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst
index b21d9f01ed35..44a49563917c 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst
@@ -1,6 +1,9 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-SRGGB10:
+.. _v4l2-pix-fmt-sbggr10:
+.. _v4l2-pix-fmt-sgbrg10:
+.. _v4l2-pix-fmt-sgrbg10:
***************************************************************************************************************************
V4L2_PIX_FMT_SRGGB10 ('RG10'), V4L2_PIX_FMT_SGRBG10 ('BA10'), V4L2_PIX_FMT_SGBRG10 ('GB10'), V4L2_PIX_FMT_SBGGR10 ('BG10'),
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst
index 4e221629bcb3..68bae0cb764c 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst
@@ -1,6 +1,9 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-SBGGR10ALAW8:
+.. _v4l2-pix-fmt-sgbrg10alaw8:
+.. _v4l2-pix-fmt-sgrbg10alaw8:
+.. _v4l2-pix-fmt-srggb10alaw8:
***********************************************************************************************************************************************
V4L2_PIX_FMT_SBGGR10ALAW8 ('aBA8'), V4L2_PIX_FMT_SGBRG10ALAW8 ('aGA8'), V4L2_PIX_FMT_SGRBG10ALAW8 ('agA8'), V4L2_PIX_FMT_SRGGB10ALAW8 ('aRA8'),
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
index 23e7db7333ba..5e041d02eff0 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst
@@ -1,6 +1,10 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-SBGGR10DPCM8:
+.. _v4l2-pix-fmt-sgbrg10dpcm8:
+.. _v4l2-pix-fmt-sgrbg10dpcm8:
+.. _v4l2-pix-fmt-srggb10dpcm8:
+
***********************************************************************************************************************************************
V4L2_PIX_FMT_SBGGR10DPCM8 ('bBA8'), V4L2_PIX_FMT_SGBRG10DPCM8 ('bGA8'), V4L2_PIX_FMT_SGRBG10DPCM8 ('BD10'), V4L2_PIX_FMT_SRGGB10DPCM8 ('bRA8'),
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst
index 9b4a1d9951ba..d71368f69087 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst
@@ -1,6 +1,9 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-SRGGB10P:
+.. _v4l2-pix-fmt-sbggr10p:
+.. _v4l2-pix-fmt-sgbrg10p:
+.. _v4l2-pix-fmt-sgrbg10p:
*******************************************************************************************************************************
V4L2_PIX_FMT_SRGGB10P ('pRAA'), V4L2_PIX_FMT_SGRBG10P ('pgAA'), V4L2_PIX_FMT_SGBRG10P ('pGAA'), V4L2_PIX_FMT_SBGGR10P ('pBAA'),
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst b/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst
index 86694681033a..f5303ab9e79c 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst
@@ -1,6 +1,10 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-SRGGB12:
+.. _v4l2-pix-fmt-sbggr12:
+.. _v4l2-pix-fmt-sgbrg12:
+.. _v4l2-pix-fmt-sgrbg12:
+
***************************************************************************************************************************
V4L2_PIX_FMT_SRGGB12 ('RG12'), V4L2_PIX_FMT_SGRBG12 ('BA12'), V4L2_PIX_FMT_SGBRG12 ('GB12'), V4L2_PIX_FMT_SBGGR12 ('BG12'),
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst
index c51b4e2f108f..8a5d1a2ee005 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-YVU410:
+.. _v4l2-pix-fmt-yuv410:
**********************************************************
V4L2_PIX_FMT_YVU410 ('YVU9'), V4L2_PIX_FMT_YUV410 ('YUV9')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst
index 0faf15cac881..4dab85090d7d 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-YUV420M:
+.. _v4l2-pix-fmt-yvu420m:
************************************************************
V4L2_PIX_FMT_YUV420M ('YM12'), V4L2_PIX_FMT_YVU420M ('YM21')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
index 6850b359c887..ccb67284133a 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-YUV422M:
+.. _v4l2-pix-fmt-yvu422m:
************************************************************
V4L2_PIX_FMT_YUV422M ('YM16'), V4L2_PIX_FMT_YVU422M ('YM61')
diff --git a/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst b/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
index b04b2f4a8f17..04f34508b934 100644
--- a/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
+++ b/Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst
@@ -1,6 +1,7 @@
.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-PIX-FMT-YUV444M:
+.. _v4l2-pix-fmt-yvu444m:
************************************************************
V4L2_PIX_FMT_YUV444M ('YM24'), V4L2_PIX_FMT_YVU444M ('YM42')
diff --git a/Documentation/linux_tv/videodev2.h.rst.exceptions b/Documentation/linux_tv/videodev2.h.rst.exceptions
index abc9144feba9..2c49287b6d59 100644
--- a/Documentation/linux_tv/videodev2.h.rst.exceptions
+++ b/Documentation/linux_tv/videodev2.h.rst.exceptions
@@ -141,148 +141,6 @@ ignore define V4L2_CAP_READWRITE
ignore define V4L2_CAP_ASYNCIO
ignore define V4L2_CAP_STREAMING
ignore define V4L2_CAP_DEVICE_CAPS
-ignore define V4L2_PIX_FMT_RGB332
-ignore define V4L2_PIX_FMT_RGB444
-ignore define V4L2_PIX_FMT_ARGB444
-ignore define V4L2_PIX_FMT_XRGB444
-ignore define V4L2_PIX_FMT_RGB555
-ignore define V4L2_PIX_FMT_ARGB555
-ignore define V4L2_PIX_FMT_XRGB555
-ignore define V4L2_PIX_FMT_RGB565
-ignore define V4L2_PIX_FMT_RGB555X
-ignore define V4L2_PIX_FMT_ARGB555X
-ignore define V4L2_PIX_FMT_XRGB555X
-ignore define V4L2_PIX_FMT_RGB565X
-ignore define V4L2_PIX_FMT_BGR666
-ignore define V4L2_PIX_FMT_BGR24
-ignore define V4L2_PIX_FMT_RGB24
-ignore define V4L2_PIX_FMT_BGR32
-ignore define V4L2_PIX_FMT_ABGR32
-ignore define V4L2_PIX_FMT_XBGR32
-ignore define V4L2_PIX_FMT_RGB32
-ignore define V4L2_PIX_FMT_ARGB32
-ignore define V4L2_PIX_FMT_XRGB32
-ignore define V4L2_PIX_FMT_GREY
-ignore define V4L2_PIX_FMT_Y4
-ignore define V4L2_PIX_FMT_Y6
-ignore define V4L2_PIX_FMT_Y10
-ignore define V4L2_PIX_FMT_Y12
-ignore define V4L2_PIX_FMT_Y16
-ignore define V4L2_PIX_FMT_Y16_BE
-ignore define V4L2_PIX_FMT_Y10BPACK
-ignore define V4L2_PIX_FMT_PAL8
-ignore define V4L2_PIX_FMT_UV8
-ignore define V4L2_PIX_FMT_YUYV
-ignore define V4L2_PIX_FMT_YYUV
-ignore define V4L2_PIX_FMT_YVYU
-ignore define V4L2_PIX_FMT_UYVY
-ignore define V4L2_PIX_FMT_VYUY
-ignore define V4L2_PIX_FMT_Y41P
-ignore define V4L2_PIX_FMT_YUV444
-ignore define V4L2_PIX_FMT_YUV555
-ignore define V4L2_PIX_FMT_YUV565
-ignore define V4L2_PIX_FMT_YUV32
-ignore define V4L2_PIX_FMT_HI240
-ignore define V4L2_PIX_FMT_HM12
-ignore define V4L2_PIX_FMT_M420
-ignore define V4L2_PIX_FMT_NV12
-ignore define V4L2_PIX_FMT_NV21
-ignore define V4L2_PIX_FMT_NV16
-ignore define V4L2_PIX_FMT_NV61
-ignore define V4L2_PIX_FMT_NV24
-ignore define V4L2_PIX_FMT_NV42
-ignore define V4L2_PIX_FMT_NV12M
-ignore define V4L2_PIX_FMT_NV21M
-ignore define V4L2_PIX_FMT_NV16M
-ignore define V4L2_PIX_FMT_NV61M
-ignore define V4L2_PIX_FMT_NV12MT
-ignore define V4L2_PIX_FMT_NV12MT_16X16
-ignore define V4L2_PIX_FMT_YUV410
-ignore define V4L2_PIX_FMT_YVU410
-ignore define V4L2_PIX_FMT_YUV411P
-ignore define V4L2_PIX_FMT_YUV420
-ignore define V4L2_PIX_FMT_YVU420
-ignore define V4L2_PIX_FMT_YUV422P
-ignore define V4L2_PIX_FMT_YUV420M
-ignore define V4L2_PIX_FMT_YVU420M
-ignore define V4L2_PIX_FMT_YUV422M
-ignore define V4L2_PIX_FMT_YVU422M
-ignore define V4L2_PIX_FMT_YUV444M
-ignore define V4L2_PIX_FMT_YVU444M
-ignore define V4L2_PIX_FMT_SBGGR8
-ignore define V4L2_PIX_FMT_SGBRG8
-ignore define V4L2_PIX_FMT_SGRBG8
-ignore define V4L2_PIX_FMT_SRGGB8
-ignore define V4L2_PIX_FMT_SBGGR10
-ignore define V4L2_PIX_FMT_SGBRG10
-ignore define V4L2_PIX_FMT_SGRBG10
-ignore define V4L2_PIX_FMT_SRGGB10
-ignore define V4L2_PIX_FMT_SBGGR10P
-ignore define V4L2_PIX_FMT_SGBRG10P
-ignore define V4L2_PIX_FMT_SGRBG10P
-ignore define V4L2_PIX_FMT_SRGGB10P
-ignore define V4L2_PIX_FMT_SBGGR10ALAW8
-ignore define V4L2_PIX_FMT_SGBRG10ALAW8
-ignore define V4L2_PIX_FMT_SGRBG10ALAW8
-ignore define V4L2_PIX_FMT_SRGGB10ALAW8
-ignore define V4L2_PIX_FMT_SBGGR10DPCM8
-ignore define V4L2_PIX_FMT_SGBRG10DPCM8
-ignore define V4L2_PIX_FMT_SGRBG10DPCM8
-ignore define V4L2_PIX_FMT_SRGGB10DPCM8
-ignore define V4L2_PIX_FMT_SBGGR12
-ignore define V4L2_PIX_FMT_SGBRG12
-ignore define V4L2_PIX_FMT_SGRBG12
-ignore define V4L2_PIX_FMT_SRGGB12
-ignore define V4L2_PIX_FMT_SBGGR16
-ignore define V4L2_PIX_FMT_MJPEG
-ignore define V4L2_PIX_FMT_JPEG
-ignore define V4L2_PIX_FMT_DV
-ignore define V4L2_PIX_FMT_MPEG
-ignore define V4L2_PIX_FMT_H264
-ignore define V4L2_PIX_FMT_H264_NO_SC
-ignore define V4L2_PIX_FMT_H264_MVC
-ignore define V4L2_PIX_FMT_H263
-ignore define V4L2_PIX_FMT_MPEG1
-ignore define V4L2_PIX_FMT_MPEG2
-ignore define V4L2_PIX_FMT_MPEG4
-ignore define V4L2_PIX_FMT_XVID
-ignore define V4L2_PIX_FMT_VC1_ANNEX_G
-ignore define V4L2_PIX_FMT_VC1_ANNEX_L
-ignore define V4L2_PIX_FMT_VP8
-ignore define V4L2_PIX_FMT_CPIA1
-ignore define V4L2_PIX_FMT_WNVA
-ignore define V4L2_PIX_FMT_SN9C10X
-ignore define V4L2_PIX_FMT_SN9C20X_I420
-ignore define V4L2_PIX_FMT_PWC1
-ignore define V4L2_PIX_FMT_PWC2
-ignore define V4L2_PIX_FMT_ET61X251
-ignore define V4L2_PIX_FMT_SPCA501
-ignore define V4L2_PIX_FMT_SPCA505
-ignore define V4L2_PIX_FMT_SPCA508
-ignore define V4L2_PIX_FMT_SPCA561
-ignore define V4L2_PIX_FMT_PAC207
-ignore define V4L2_PIX_FMT_MR97310A
-ignore define V4L2_PIX_FMT_JL2005BCD
-ignore define V4L2_PIX_FMT_SN9C2028
-ignore define V4L2_PIX_FMT_SQ905C
-ignore define V4L2_PIX_FMT_PJPG
-ignore define V4L2_PIX_FMT_OV511
-ignore define V4L2_PIX_FMT_OV518
-ignore define V4L2_PIX_FMT_STV0680
-ignore define V4L2_PIX_FMT_TM6000
-ignore define V4L2_PIX_FMT_CIT_YYVYUY
-ignore define V4L2_PIX_FMT_KONICA420
-ignore define V4L2_PIX_FMT_JPGL
-ignore define V4L2_PIX_FMT_SE401
-ignore define V4L2_PIX_FMT_S5C_UYVY_JPG
-ignore define V4L2_PIX_FMT_Y8I
-ignore define V4L2_PIX_FMT_Y12I
-ignore define V4L2_PIX_FMT_Z16
-ignore define V4L2_SDR_FMT_CU8
-ignore define V4L2_SDR_FMT_CU16LE
-ignore define V4L2_SDR_FMT_CS8
-ignore define V4L2_SDR_FMT_CS14LE
-ignore define V4L2_SDR_FMT_RU12LE
ignore define V4L2_PIX_FMT_PRIV_MAGIC
ignore define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA
ignore define V4L2_FMT_FLAG_COMPRESSED
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 48/54] doc-rst: videodev2.h: don't ignore V4L2_STD macros
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (46 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 47/54] doc-rst: linux_tv: Don't ignore pix formats Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 49/54] doc-rst: document enum symbols Mauro Carvalho Chehab
` (6 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
The content of those macros are all declared at the v4l2-std-id
table. So, point to it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/videodev2.h.rst.exceptions | 94 ++++++++++++-----------
1 file changed, 48 insertions(+), 46 deletions(-)
diff --git a/Documentation/linux_tv/videodev2.h.rst.exceptions b/Documentation/linux_tv/videodev2.h.rst.exceptions
index 2c49287b6d59..8cad3ba6ba99 100644
--- a/Documentation/linux_tv/videodev2.h.rst.exceptions
+++ b/Documentation/linux_tv/videodev2.h.rst.exceptions
@@ -196,52 +196,6 @@ ignore define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA
ignore define V4L2_FBUF_FLAG_SRC_CHROMAKEY
ignore define V4L2_MODE_HIGHQUALITY
ignore define V4L2_CAP_TIMEPERFRAME
-ignore define V4L2_STD_PAL_B
-ignore define V4L2_STD_PAL_B1
-ignore define V4L2_STD_PAL_G
-ignore define V4L2_STD_PAL_H
-ignore define V4L2_STD_PAL_I
-ignore define V4L2_STD_PAL_D
-ignore define V4L2_STD_PAL_D1
-ignore define V4L2_STD_PAL_K
-ignore define V4L2_STD_PAL_M
-ignore define V4L2_STD_PAL_N
-ignore define V4L2_STD_PAL_Nc
-ignore define V4L2_STD_PAL_60
-ignore define V4L2_STD_NTSC_M
-ignore define V4L2_STD_NTSC_M_JP
-ignore define V4L2_STD_NTSC_443
-ignore define V4L2_STD_NTSC_M_KR
-ignore define V4L2_STD_SECAM_B
-ignore define V4L2_STD_SECAM_D
-ignore define V4L2_STD_SECAM_G
-ignore define V4L2_STD_SECAM_H
-ignore define V4L2_STD_SECAM_K
-ignore define V4L2_STD_SECAM_K1
-ignore define V4L2_STD_SECAM_L
-ignore define V4L2_STD_SECAM_LC
-ignore define V4L2_STD_ATSC_8_VSB
-ignore define V4L2_STD_ATSC_16_VSB
-ignore define V4L2_STD_NTSC
-ignore define V4L2_STD_SECAM_DK
-ignore define V4L2_STD_SECAM
-ignore define V4L2_STD_PAL_BG
-ignore define V4L2_STD_PAL_DK
-ignore define V4L2_STD_PAL
-ignore define V4L2_STD_B
-ignore define V4L2_STD_G
-ignore define V4L2_STD_H
-ignore define V4L2_STD_L
-ignore define V4L2_STD_GH
-ignore define V4L2_STD_DK
-ignore define V4L2_STD_BG
-ignore define V4L2_STD_MN
-ignore define V4L2_STD_MTS
-ignore define V4L2_STD_525_60
-ignore define V4L2_STD_625_50
-ignore define V4L2_STD_ATSC
-ignore define V4L2_STD_UNKNOWN
-ignore define V4L2_STD_ALL
ignore define V4L2_DV_PROGRESSIVE
ignore define V4L2_DV_INTERLACED
ignore define V4L2_DV_VSYNC_POS_POL
@@ -414,6 +368,54 @@ ignore define V4L2_CHIP_FL_READABLE
ignore define V4L2_CHIP_FL_WRITABLE
ignore define BASE_VIDIOC_PRIVATE
+# The V4L2_STD_foo are all defined at v4l2_std_id table
+replace define V4L2_STD_PAL_B v4l2-std-id
+replace define V4L2_STD_PAL_B1 v4l2-std-id
+replace define V4L2_STD_PAL_G v4l2-std-id
+replace define V4L2_STD_PAL_H v4l2-std-id
+replace define V4L2_STD_PAL_I v4l2-std-id
+replace define V4L2_STD_PAL_D v4l2-std-id
+replace define V4L2_STD_PAL_D1 v4l2-std-id
+replace define V4L2_STD_PAL_K v4l2-std-id
+replace define V4L2_STD_PAL_M v4l2-std-id
+replace define V4L2_STD_PAL_N v4l2-std-id
+replace define V4L2_STD_PAL_Nc v4l2-std-id
+replace define V4L2_STD_PAL_60 v4l2-std-id
+replace define V4L2_STD_NTSC_M v4l2-std-id
+replace define V4L2_STD_NTSC_M_JP v4l2-std-id
+replace define V4L2_STD_NTSC_443 v4l2-std-id
+replace define V4L2_STD_NTSC_M_KR v4l2-std-id
+replace define V4L2_STD_SECAM_B v4l2-std-id
+replace define V4L2_STD_SECAM_D v4l2-std-id
+replace define V4L2_STD_SECAM_G v4l2-std-id
+replace define V4L2_STD_SECAM_H v4l2-std-id
+replace define V4L2_STD_SECAM_K v4l2-std-id
+replace define V4L2_STD_SECAM_K1 v4l2-std-id
+replace define V4L2_STD_SECAM_L v4l2-std-id
+replace define V4L2_STD_SECAM_LC v4l2-std-id
+replace define V4L2_STD_ATSC_8_VSB v4l2-std-id
+replace define V4L2_STD_ATSC_16_VSB v4l2-std-id
+replace define V4L2_STD_NTSC v4l2-std-id
+replace define V4L2_STD_SECAM_DK v4l2-std-id
+replace define V4L2_STD_SECAM v4l2-std-id
+replace define V4L2_STD_PAL_BG v4l2-std-id
+replace define V4L2_STD_PAL_DK v4l2-std-id
+replace define V4L2_STD_PAL v4l2-std-id
+replace define V4L2_STD_B v4l2-std-id
+replace define V4L2_STD_G v4l2-std-id
+replace define V4L2_STD_H v4l2-std-id
+replace define V4L2_STD_L v4l2-std-id
+replace define V4L2_STD_GH v4l2-std-id
+replace define V4L2_STD_DK v4l2-std-id
+replace define V4L2_STD_BG v4l2-std-id
+replace define V4L2_STD_MN v4l2-std-id
+replace define V4L2_STD_MTS v4l2-std-id
+replace define V4L2_STD_525_60 v4l2-std-id
+replace define V4L2_STD_625_50 v4l2-std-id
+replace define V4L2_STD_ATSC v4l2-std-id
+replace define V4L2_STD_UNKNOWN v4l2-std-id
+replace define V4L2_STD_ALL v4l2-std-id
+
# Ignore reserved ioctl
ignore ioctl VIDIOC_RESERVED
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 49/54] doc-rst: document enum symbols
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (47 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 48/54] doc-rst: videodev2.h: don't ignore V4L2_STD macros Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 50/54] doc-rst: videodev2.h: add cross-references for defines Mauro Carvalho Chehab
` (5 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
After checking that all enum fields are documented at the
corresponding table on the rst file, let's point to the
table, instead of ignore the symbols.
A few symbols are not meant to be documented, as they're
deprecated stuff. keep ignoring them.
One enum field is not documented. Either it is obsolete
or a documentation gap. So, produce warnings for it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/videodev2.h.rst.exceptions | 206 ++++++++++++----------
1 file changed, 116 insertions(+), 90 deletions(-)
diff --git a/Documentation/linux_tv/videodev2.h.rst.exceptions b/Documentation/linux_tv/videodev2.h.rst.exceptions
index 8cad3ba6ba99..6231549294c1 100644
--- a/Documentation/linux_tv/videodev2.h.rst.exceptions
+++ b/Documentation/linux_tv/videodev2.h.rst.exceptions
@@ -9,98 +9,124 @@ ignore define _UAPI__LINUX_VIDEODEV2_H
# having something not documented at the uAPI.
#
-# for now, ignore all enum symbols
+# Those symbols should not be used by uAPI - don't document them
ignore symbol V4L2_BUF_TYPE_PRIVATE
-ignore symbol V4L2_BUF_TYPE_SDR_CAPTURE
-ignore symbol V4L2_BUF_TYPE_SDR_OUTPUT
-ignore symbol V4L2_BUF_TYPE_SLICED_VBI_CAPTURE
-ignore symbol V4L2_BUF_TYPE_SLICED_VBI_OUTPUT
-ignore symbol V4L2_BUF_TYPE_VBI_CAPTURE
-ignore symbol V4L2_BUF_TYPE_VBI_OUTPUT
-ignore symbol V4L2_BUF_TYPE_VIDEO_CAPTURE
-ignore symbol V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE
-ignore symbol V4L2_BUF_TYPE_VIDEO_OUTPUT
-ignore symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE
-ignore symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY
-ignore symbol V4L2_BUF_TYPE_VIDEO_OVERLAY
-ignore symbol V4L2_COLORSPACE_470_SYSTEM_BG
-ignore symbol V4L2_COLORSPACE_470_SYSTEM_M
-ignore symbol V4L2_COLORSPACE_ADOBERGB
-ignore symbol V4L2_COLORSPACE_BT2020
-ignore symbol V4L2_COLORSPACE_BT878
-ignore symbol V4L2_COLORSPACE_DCI_P3
-ignore symbol V4L2_COLORSPACE_DEFAULT
-ignore symbol V4L2_COLORSPACE_JPEG
-ignore symbol V4L2_COLORSPACE_RAW
-ignore symbol V4L2_COLORSPACE_REC709
-ignore symbol V4L2_COLORSPACE_SMPTE170M
-ignore symbol V4L2_COLORSPACE_SMPTE240M
-ignore symbol V4L2_COLORSPACE_SRGB
-ignore symbol V4L2_CTRL_COMPOUND_TYPES
-ignore symbol V4L2_CTRL_TYPE_BITMASK
-ignore symbol V4L2_CTRL_TYPE_BOOLEAN
-ignore symbol V4L2_CTRL_TYPE_BUTTON
-ignore symbol V4L2_CTRL_TYPE_CTRL_CLASS
-ignore symbol V4L2_CTRL_TYPE_INTEGER
-ignore symbol V4L2_CTRL_TYPE_INTEGER64
-ignore symbol V4L2_CTRL_TYPE_INTEGER_MENU
-ignore symbol V4L2_CTRL_TYPE_MENU
-ignore symbol V4L2_CTRL_TYPE_STRING
-ignore symbol V4L2_CTRL_TYPE_U16
-ignore symbol V4L2_CTRL_TYPE_U32
-ignore symbol V4L2_CTRL_TYPE_U8
-ignore symbol V4L2_FIELD_ALTERNATE
-ignore symbol V4L2_FIELD_ANY
-ignore symbol V4L2_FIELD_BOTTOM
-ignore symbol V4L2_FIELD_INTERLACED
-ignore symbol V4L2_FIELD_INTERLACED_BT
-ignore symbol V4L2_FIELD_INTERLACED_TB
-ignore symbol V4L2_FIELD_NONE
-ignore symbol V4L2_FIELD_SEQ_BT
-ignore symbol V4L2_FIELD_SEQ_TB
-ignore symbol V4L2_FIELD_TOP
-ignore symbol V4L2_FRMIVAL_TYPE_CONTINUOUS
-ignore symbol V4L2_FRMIVAL_TYPE_DISCRETE
-ignore symbol V4L2_FRMIVAL_TYPE_STEPWISE
-ignore symbol V4L2_FRMSIZE_TYPE_CONTINUOUS
-ignore symbol V4L2_FRMSIZE_TYPE_DISCRETE
-ignore symbol V4L2_FRMSIZE_TYPE_STEPWISE
-ignore symbol V4L2_MEMORY_DMABUF
-ignore symbol V4L2_MEMORY_MMAP
-ignore symbol V4L2_MEMORY_OVERLAY
-ignore symbol V4L2_MEMORY_USERPTR
-ignore symbol V4L2_PRIORITY_BACKGROUND
-ignore symbol V4L2_PRIORITY_DEFAULT
-ignore symbol V4L2_PRIORITY_INTERACTIVE
-ignore symbol V4L2_PRIORITY_RECORD
-ignore symbol V4L2_PRIORITY_UNSET
-ignore symbol V4L2_QUANTIZATION_DEFAULT
-ignore symbol V4L2_QUANTIZATION_FULL_RANGE
-ignore symbol V4L2_QUANTIZATION_LIM_RANGE
-ignore symbol V4L2_TUNER_ANALOG_TV
ignore symbol V4L2_TUNER_DIGITAL_TV
-ignore symbol V4L2_TUNER_RADIO
-ignore symbol V4L2_TUNER_RF
-ignore symbol V4L2_TUNER_SDR
-ignore symbol V4L2_XFER_FUNC_709
-ignore symbol V4L2_XFER_FUNC_ADOBERGB
-ignore symbol V4L2_XFER_FUNC_DCI_P3
-ignore symbol V4L2_XFER_FUNC_DEFAULT
-ignore symbol V4L2_XFER_FUNC_NONE
-ignore symbol V4L2_XFER_FUNC_SMPTE2084
-ignore symbol V4L2_XFER_FUNC_SMPTE240M
-ignore symbol V4L2_XFER_FUNC_SRGB
-ignore symbol V4L2_YCBCR_ENC_601
-ignore symbol V4L2_YCBCR_ENC_709
-ignore symbol V4L2_YCBCR_ENC_BT2020
-ignore symbol V4L2_YCBCR_ENC_BT2020_CONST_LUM
-ignore symbol V4L2_YCBCR_ENC_DEFAULT
-ignore symbol V4L2_YCBCR_ENC_SMPTE240M
-ignore symbol V4L2_YCBCR_ENC_SYCC
-ignore symbol V4L2_YCBCR_ENC_XV601
-ignore symbol V4L2_YCBCR_ENC_XV709
-
-# For now, ignore all defines
+ignore symbol V4L2_COLORSPACE_BT878
+
+# Documented enum v4l2_field
+replace symbol V4L2_FIELD_ALTERNATE v4l2-field
+replace symbol V4L2_FIELD_ANY v4l2-field
+replace symbol V4L2_FIELD_BOTTOM v4l2-field
+replace symbol V4L2_FIELD_INTERLACED v4l2-field
+replace symbol V4L2_FIELD_INTERLACED_BT v4l2-field
+replace symbol V4L2_FIELD_INTERLACED_TB v4l2-field
+replace symbol V4L2_FIELD_NONE v4l2-field
+replace symbol V4L2_FIELD_SEQ_BT v4l2-field
+replace symbol V4L2_FIELD_SEQ_TB v4l2-field
+replace symbol V4L2_FIELD_TOP v4l2-field
+
+# Documented enum v4l2_buf_type
+replace symbol V4L2_BUF_TYPE_SDR_CAPTURE v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_SDR_OUTPUT v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_SLICED_VBI_CAPTURE v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_SLICED_VBI_OUTPUT v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VBI_CAPTURE v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VBI_OUTPUT v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VIDEO_CAPTURE v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VIDEO_OUTPUT v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VIDEO_OUTPUT_OVERLAY v4l2-buf-type
+replace symbol V4L2_BUF_TYPE_VIDEO_OVERLAY v4l2-buf-type
+
+# Documented enum v4l2_tuner_type
+replace symbol V4L2_TUNER_ANALOG_TV v4l2-tuner-type
+replace symbol V4L2_TUNER_RADIO v4l2-tuner-type
+replace symbol V4L2_TUNER_RF v4l2-tuner-type
+replace symbol V4L2_TUNER_SDR v4l2-tuner-type
+
+# Documented enum v4l2_memory
+replace symbol V4L2_MEMORY_DMABUF v4l2-memory
+replace symbol V4L2_MEMORY_MMAP v4l2-memory
+replace symbol V4L2_MEMORY_OVERLAY v4l2-memory
+replace symbol V4L2_MEMORY_USERPTR v4l2-memory
+
+# Documented enum v4l2_colorspace
+replace symbol V4L2_COLORSPACE_470_SYSTEM_BG v4l2-colorspace
+replace symbol V4L2_COLORSPACE_470_SYSTEM_M v4l2-colorspace
+replace symbol V4L2_COLORSPACE_ADOBERGB v4l2-colorspace
+replace symbol V4L2_COLORSPACE_BT2020 v4l2-colorspace
+replace symbol V4L2_COLORSPACE_DCI_P3 v4l2-colorspace
+replace symbol V4L2_COLORSPACE_DEFAULT v4l2-colorspace
+replace symbol V4L2_COLORSPACE_JPEG v4l2-colorspace
+replace symbol V4L2_COLORSPACE_RAW v4l2-colorspace
+replace symbol V4L2_COLORSPACE_REC709 v4l2-colorspace
+replace symbol V4L2_COLORSPACE_SMPTE170M v4l2-colorspace
+replace symbol V4L2_COLORSPACE_SMPTE240M v4l2-colorspace
+replace symbol V4L2_COLORSPACE_SRGB v4l2-colorspace
+
+# Documented enum v4l2_xfer_func
+replace symbol V4L2_XFER_FUNC_709 v4l2-xfer-func
+replace symbol V4L2_XFER_FUNC_ADOBERGB v4l2-xfer-func
+replace symbol V4L2_XFER_FUNC_DCI_P3 v4l2-xfer-func
+replace symbol V4L2_XFER_FUNC_DEFAULT v4l2-xfer-func
+replace symbol V4L2_XFER_FUNC_NONE v4l2-xfer-func
+replace symbol V4L2_XFER_FUNC_SMPTE2084 v4l2-xfer-func
+replace symbol V4L2_XFER_FUNC_SMPTE240M v4l2-xfer-func
+replace symbol V4L2_XFER_FUNC_SRGB v4l2-xfer-func
+
+# Documented enum v4l2_ycbcr_encoding
+replace symbol V4L2_YCBCR_ENC_601 v4l2-ycbcr-encoding
+replace symbol V4L2_YCBCR_ENC_709 v4l2-ycbcr-encoding
+replace symbol V4L2_YCBCR_ENC_BT2020 v4l2-ycbcr-encoding
+replace symbol V4L2_YCBCR_ENC_BT2020_CONST_LUM v4l2-ycbcr-encoding
+replace symbol V4L2_YCBCR_ENC_DEFAULT v4l2-ycbcr-encoding
+replace symbol V4L2_YCBCR_ENC_SYCC v4l2-ycbcr-encoding
+replace symbol V4L2_YCBCR_ENC_XV601 v4l2-ycbcr-encoding
+replace symbol V4L2_YCBCR_ENC_XV709 v4l2-ycbcr-encoding
+
+# Is this deprecated, or just a missing reference?
+replace symbol V4L2_YCBCR_ENC_SMPTE240M v4l2-ycbcr-encoding-FIXME
+
+# Documented enum v4l2_quantization
+replace symbol V4L2_QUANTIZATION_DEFAULT v4l2-quantization
+replace symbol V4L2_QUANTIZATION_FULL_RANGE v4l2-quantization
+replace symbol V4L2_QUANTIZATION_LIM_RANGE v4l2-quantization
+
+# Documented enum v4l2_priority
+replace symbol V4L2_PRIORITY_BACKGROUND v4l2-priority
+replace symbol V4L2_PRIORITY_DEFAULT v4l2-priority
+replace symbol V4L2_PRIORITY_INTERACTIVE v4l2-priority
+replace symbol V4L2_PRIORITY_RECORD v4l2-priority
+replace symbol V4L2_PRIORITY_UNSET v4l2-priority
+
+# Documented enum v4l2_frmsizetypes
+replace symbol V4L2_FRMSIZE_TYPE_CONTINUOUS v4l2-frmsizetypes
+replace symbol V4L2_FRMSIZE_TYPE_DISCRETE v4l2-frmsizetypes
+replace symbol V4L2_FRMSIZE_TYPE_STEPWISE v4l2-frmsizetypes
+
+# Documented enum frmivaltypes
+replace symbol V4L2_FRMIVAL_TYPE_CONTINUOUS v4l2-frmivaltypes
+replace symbol V4L2_FRMIVAL_TYPE_DISCRETE v4l2-frmivaltypes
+replace symbol V4L2_FRMIVAL_TYPE_STEPWISE v4l2-frmivaltypes
+
+# Documented enum v4l2-ctrl-type
+replace symbol V4L2_CTRL_COMPOUND_TYPES vidioc_queryctrl
+replace symbol V4L2_CTRL_TYPE_BITMASK v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_BOOLEAN v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_BUTTON v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_CTRL_CLASS v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_INTEGER v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_INTEGER64 v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_INTEGER_MENU v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_MENU v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_STRING v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_U16 v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_U32 v4l2-ctrl-type
+replace symbol V4L2_CTRL_TYPE_U8 v4l2-ctrl-type
+
+# Ancillary macros that should be ignored
ignore define VIDEO_MAX_FRAME
ignore define VIDEO_MAX_PLANES
ignore define v4l2_fourcc
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 50/54] doc-rst: videodev2.h: add cross-references for defines
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (48 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 49/54] doc-rst: document enum symbols Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 51/54] doc-rst: linux_tv/Makefile: Honor quiet mode Mauro Carvalho Chehab
` (4 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Remove most of ignore stuff for defines, pointing them to the
proper tables/sections.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
.../linux_tv/media/v4l/vidioc-dv-timings-cap.rst | 8 +-
.../linux_tv/media/v4l/vidioc-g-dv-timings.rst | 26 +-
Documentation/linux_tv/videodev2.h.rst.exceptions | 618 ++++++++++++---------
3 files changed, 367 insertions(+), 285 deletions(-)
diff --git a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
index b56cdef7673e..5a35bb254b4b 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst
@@ -217,26 +217,26 @@ that doesn't support them will return an ``EINVAL`` error code.
- .. row 3
- - V4L2_DV_BT_CAP_INTERLACED
+ - ``V4L2_DV_BT_CAP_INTERLACED``
- Interlaced formats are supported.
- .. row 4
- - V4L2_DV_BT_CAP_PROGRESSIVE
+ - ``V4L2_DV_BT_CAP_PROGRESSIVE``
- Progressive formats are supported.
- .. row 5
- - V4L2_DV_BT_CAP_REDUCED_BLANKING
+ - ``V4L2_DV_BT_CAP_REDUCED_BLANKING``
- CVT/GTF specific: the timings can make use of reduced blanking
(CVT) or the 'Secondary GTF' curve (GTF).
- .. row 6
- - V4L2_DV_BT_CAP_CUSTOM
+ - ``V4L2_DV_BT_CAP_CUSTOM``
- Can support non-standard timings, i.e. timings not belonging to
the standards set in the ``standards`` field.
diff --git a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
index 0dd93d1ee284..e19d64e0116a 100644
--- a/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
+++ b/Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst
@@ -109,8 +109,8 @@ EBUSY
- ``polarities``
- This is a bit mask that defines polarities of sync signals. bit 0
- (V4L2_DV_VSYNC_POS_POL) is for vertical sync polarity and bit
- 1 (V4L2_DV_HSYNC_POS_POL) is for horizontal sync polarity. If
+ (``V4L2_DV_VSYNC_POS_POL``) is for vertical sync polarity and bit
+ 1 (``V4L2_DV_HSYNC_POS_POL``) is for horizontal sync polarity. If
the bit is set (1) it is positive polarity and if is cleared (0),
it is negative polarity.
@@ -289,7 +289,7 @@ EBUSY
- .. row 3
- - V4L2_DV_BT_656_1120
+ - ``V4L2_DV_BT_656_1120``
- 0
@@ -317,25 +317,25 @@ EBUSY
- .. row 3
- - V4L2_DV_BT_STD_CEA861
+ - ``V4L2_DV_BT_STD_CEA861``
- The timings follow the CEA-861 Digital TV Profile standard
- .. row 4
- - V4L2_DV_BT_STD_DMT
+ - ``V4L2_DV_BT_STD_DMT``
- The timings follow the VESA Discrete Monitor Timings standard
- .. row 5
- - V4L2_DV_BT_STD_CVT
+ - ``V4L2_DV_BT_STD_CVT``
- The timings follow the VESA Coordinated Video Timings standard
- .. row 6
- - V4L2_DV_BT_STD_GTF
+ - ``V4L2_DV_BT_STD_GTF``
- The timings follow the VESA Generalized Timings Formula standard
@@ -361,7 +361,7 @@ EBUSY
- .. row 3
- - V4L2_DV_FL_REDUCED_BLANKING
+ - ``V4L2_DV_FL_REDUCED_BLANKING``
- CVT/GTF specific: the timings use reduced blanking (CVT) or the
'Secondary GTF' curve (GTF). In both cases the horizontal and/or
@@ -371,7 +371,7 @@ EBUSY
- .. row 4
- - V4L2_DV_FL_CAN_REDUCE_FPS
+ - ``V4L2_DV_FL_CAN_REDUCE_FPS``
- CEA-861 specific: set for CEA-861 formats with a framerate that is
a multiple of six. These formats can be optionally played at 1 /
@@ -383,11 +383,11 @@ EBUSY
- .. row 5
- - V4L2_DV_FL_REDUCED_FPS
+ - ``V4L2_DV_FL_REDUCED_FPS``
- CEA-861 specific: only valid for video transmitters, the flag is
cleared by receivers. It is also only valid for formats with the
- V4L2_DV_FL_CAN_REDUCE_FPS flag set, for other formats the
+ ``V4L2_DV_FL_CAN_REDUCE_FPS`` flag set, for other formats the
flag will be cleared by the driver. If the application sets this
flag, then the pixelclock used to set up the transmitter is
divided by 1.001 to make it compatible with NTSC framerates. If
@@ -396,7 +396,7 @@ EBUSY
- .. row 6
- - V4L2_DV_FL_HALF_LINE
+ - ``V4L2_DV_FL_HALF_LINE``
- Specific to interlaced formats: if set, then the vertical
frontporch of field 1 (aka the odd field) is really one half-line
@@ -407,7 +407,7 @@ EBUSY
- .. row 7
- - V4L2_DV_FL_IS_CE_VIDEO
+ - ``V4L2_DV_FL_IS_CE_VIDEO``
- If set, then this is a Consumer Electronics (CE) video format.
Such formats differ from other formats (commonly called IT
diff --git a/Documentation/linux_tv/videodev2.h.rst.exceptions b/Documentation/linux_tv/videodev2.h.rst.exceptions
index 6231549294c1..c15660f5c588 100644
--- a/Documentation/linux_tv/videodev2.h.rst.exceptions
+++ b/Documentation/linux_tv/videodev2.h.rst.exceptions
@@ -113,6 +113,7 @@ replace symbol V4L2_FRMIVAL_TYPE_STEPWISE v4l2-frmivaltypes
# Documented enum v4l2-ctrl-type
replace symbol V4L2_CTRL_COMPOUND_TYPES vidioc_queryctrl
+
replace symbol V4L2_CTRL_TYPE_BITMASK v4l2-ctrl-type
replace symbol V4L2_CTRL_TYPE_BOOLEAN v4l2-ctrl-type
replace symbol V4L2_CTRL_TYPE_BUTTON v4l2-ctrl-type
@@ -126,275 +127,110 @@ replace symbol V4L2_CTRL_TYPE_U16 v4l2-ctrl-type
replace symbol V4L2_CTRL_TYPE_U32 v4l2-ctrl-type
replace symbol V4L2_CTRL_TYPE_U8 v4l2-ctrl-type
-# Ancillary macros that should be ignored
-ignore define VIDEO_MAX_FRAME
-ignore define VIDEO_MAX_PLANES
-ignore define v4l2_fourcc
-ignore define v4l2_fourcc_be
-ignore define V4L2_FIELD_HAS_TOP
-ignore define V4L2_FIELD_HAS_BOTTOM
-ignore define V4L2_FIELD_HAS_BOTH
-ignore define V4L2_FIELD_HAS_T_OR_B
-ignore define V4L2_TYPE_IS_MULTIPLANAR
-ignore define V4L2_TYPE_IS_OUTPUT
-ignore define V4L2_TUNER_ADC
-ignore define V4L2_MAP_COLORSPACE_DEFAULT
-ignore define V4L2_MAP_XFER_FUNC_DEFAULT
-ignore define V4L2_MAP_YCBCR_ENC_DEFAULT
-ignore define V4L2_CAP_VIDEO_CAPTURE
-ignore define V4L2_CAP_VIDEO_OUTPUT
-ignore define V4L2_CAP_VIDEO_OVERLAY
-ignore define V4L2_CAP_VBI_CAPTURE
-ignore define V4L2_CAP_VBI_OUTPUT
-ignore define V4L2_CAP_SLICED_VBI_CAPTURE
-ignore define V4L2_CAP_SLICED_VBI_OUTPUT
-ignore define V4L2_CAP_RDS_CAPTURE
-ignore define V4L2_CAP_VIDEO_OUTPUT_OVERLAY
-ignore define V4L2_CAP_HW_FREQ_SEEK
-ignore define V4L2_CAP_RDS_OUTPUT
-ignore define V4L2_CAP_VIDEO_CAPTURE_MPLANE
-ignore define V4L2_CAP_VIDEO_OUTPUT_MPLANE
-ignore define V4L2_CAP_VIDEO_M2M_MPLANE
-ignore define V4L2_CAP_VIDEO_M2M
-ignore define V4L2_CAP_TUNER
-ignore define V4L2_CAP_AUDIO
-ignore define V4L2_CAP_RADIO
-ignore define V4L2_CAP_MODULATOR
-ignore define V4L2_CAP_SDR_CAPTURE
-ignore define V4L2_CAP_EXT_PIX_FORMAT
-ignore define V4L2_CAP_SDR_OUTPUT
-ignore define V4L2_CAP_READWRITE
-ignore define V4L2_CAP_ASYNCIO
-ignore define V4L2_CAP_STREAMING
-ignore define V4L2_CAP_DEVICE_CAPS
-ignore define V4L2_PIX_FMT_PRIV_MAGIC
-ignore define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA
-ignore define V4L2_FMT_FLAG_COMPRESSED
-ignore define V4L2_FMT_FLAG_EMULATED
-ignore define V4L2_TC_TYPE_24FPS
-ignore define V4L2_TC_TYPE_25FPS
-ignore define V4L2_TC_TYPE_30FPS
-ignore define V4L2_TC_TYPE_50FPS
-ignore define V4L2_TC_TYPE_60FPS
-ignore define V4L2_TC_FLAG_DROPFRAME
-ignore define V4L2_TC_FLAG_COLORFRAME
-ignore define V4L2_TC_USERBITS_field
-ignore define V4L2_TC_USERBITS_USERDEFINED
-ignore define V4L2_TC_USERBITS_8BITCHARS
-ignore define V4L2_JPEG_MARKER_DHT
-ignore define V4L2_JPEG_MARKER_DQT
-ignore define V4L2_JPEG_MARKER_DRI
-ignore define V4L2_JPEG_MARKER_COM
-ignore define V4L2_JPEG_MARKER_APP
-ignore define V4L2_BUF_FLAG_MAPPED
-ignore define V4L2_BUF_FLAG_QUEUED
-ignore define V4L2_BUF_FLAG_DONE
-ignore define V4L2_BUF_FLAG_KEYFRAME
-ignore define V4L2_BUF_FLAG_PFRAME
-ignore define V4L2_BUF_FLAG_BFRAME
-ignore define V4L2_BUF_FLAG_ERROR
-ignore define V4L2_BUF_FLAG_TIMECODE
-ignore define V4L2_BUF_FLAG_PREPARED
-ignore define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE
-ignore define V4L2_BUF_FLAG_NO_CACHE_CLEAN
-ignore define V4L2_BUF_FLAG_TIMESTAMP_MASK
-ignore define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN
-ignore define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC
-ignore define V4L2_BUF_FLAG_TIMESTAMP_COPY
-ignore define V4L2_BUF_FLAG_TSTAMP_SRC_MASK
-ignore define V4L2_BUF_FLAG_TSTAMP_SRC_EOF
-ignore define V4L2_BUF_FLAG_TSTAMP_SRC_SOE
-ignore define V4L2_BUF_FLAG_LAST
-ignore define V4L2_FBUF_CAP_EXTERNOVERLAY
-ignore define V4L2_FBUF_CAP_CHROMAKEY
-ignore define V4L2_FBUF_CAP_LIST_CLIPPING
-ignore define V4L2_FBUF_CAP_BITMAP_CLIPPING
-ignore define V4L2_FBUF_CAP_LOCAL_ALPHA
-ignore define V4L2_FBUF_CAP_GLOBAL_ALPHA
-ignore define V4L2_FBUF_CAP_LOCAL_INV_ALPHA
-ignore define V4L2_FBUF_CAP_SRC_CHROMAKEY
-ignore define V4L2_FBUF_FLAG_PRIMARY
-ignore define V4L2_FBUF_FLAG_OVERLAY
-ignore define V4L2_FBUF_FLAG_CHROMAKEY
-ignore define V4L2_FBUF_FLAG_LOCAL_ALPHA
-ignore define V4L2_FBUF_FLAG_GLOBAL_ALPHA
-ignore define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA
-ignore define V4L2_FBUF_FLAG_SRC_CHROMAKEY
-ignore define V4L2_MODE_HIGHQUALITY
-ignore define V4L2_CAP_TIMEPERFRAME
-ignore define V4L2_DV_PROGRESSIVE
-ignore define V4L2_DV_INTERLACED
-ignore define V4L2_DV_VSYNC_POS_POL
-ignore define V4L2_DV_HSYNC_POS_POL
-ignore define V4L2_DV_BT_STD_CEA861
-ignore define V4L2_DV_BT_STD_DMT
-ignore define V4L2_DV_BT_STD_CVT
-ignore define V4L2_DV_BT_STD_GTF
-ignore define V4L2_DV_FL_REDUCED_BLANKING
-ignore define V4L2_DV_FL_CAN_REDUCE_FPS
-ignore define V4L2_DV_FL_REDUCED_FPS
-ignore define V4L2_DV_FL_HALF_LINE
-ignore define V4L2_DV_FL_IS_CE_VIDEO
-ignore define V4L2_DV_BT_BLANKING_WIDTH(bt)
-ignore define V4L2_DV_BT_FRAME_WIDTH(bt)
-ignore define V4L2_DV_BT_BLANKING_HEIGHT(bt)
-ignore define V4L2_DV_BT_FRAME_HEIGHT(bt)
-ignore define V4L2_DV_BT_656_1120
-ignore define V4L2_DV_BT_CAP_INTERLACED
-ignore define V4L2_DV_BT_CAP_PROGRESSIVE
-ignore define V4L2_DV_BT_CAP_REDUCED_BLANKING
-ignore define V4L2_DV_BT_CAP_CUSTOM
-ignore define V4L2_INPUT_TYPE_TUNER
-ignore define V4L2_INPUT_TYPE_CAMERA
-ignore define V4L2_IN_ST_NO_POWER
-ignore define V4L2_IN_ST_NO_SIGNAL
-ignore define V4L2_IN_ST_NO_COLOR
-ignore define V4L2_IN_ST_HFLIP
-ignore define V4L2_IN_ST_VFLIP
-ignore define V4L2_IN_ST_NO_H_LOCK
-ignore define V4L2_IN_ST_COLOR_KILL
-ignore define V4L2_IN_ST_NO_SYNC
-ignore define V4L2_IN_ST_NO_EQU
-ignore define V4L2_IN_ST_NO_CARRIER
-ignore define V4L2_IN_ST_MACROVISION
-ignore define V4L2_IN_ST_NO_ACCESS
-ignore define V4L2_IN_ST_VTR
-ignore define V4L2_IN_CAP_DV_TIMINGS
-ignore define V4L2_IN_CAP_CUSTOM_TIMINGS
-ignore define V4L2_IN_CAP_STD
-ignore define V4L2_IN_CAP_NATIVE_SIZE
-ignore define V4L2_OUTPUT_TYPE_MODULATOR
-ignore define V4L2_OUTPUT_TYPE_ANALOG
-ignore define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY
-ignore define V4L2_OUT_CAP_DV_TIMINGS
-ignore define V4L2_OUT_CAP_CUSTOM_TIMINGS
-ignore define V4L2_OUT_CAP_STD
-ignore define V4L2_OUT_CAP_NATIVE_SIZE
-ignore define V4L2_CTRL_ID_MASK
-ignore define V4L2_CTRL_ID2CLASS(id)
-ignore define V4L2_CTRL_ID2WHICH(id)
-ignore define V4L2_CTRL_DRIVER_PRIV(id)
-ignore define V4L2_CTRL_MAX_DIMS
-ignore define V4L2_CTRL_WHICH_CUR_VAL
-ignore define V4L2_CTRL_WHICH_DEF_VAL
-ignore define V4L2_CTRL_FLAG_DISABLED
-ignore define V4L2_CTRL_FLAG_GRABBED
-ignore define V4L2_CTRL_FLAG_READ_ONLY
-ignore define V4L2_CTRL_FLAG_UPDATE
-ignore define V4L2_CTRL_FLAG_INACTIVE
-ignore define V4L2_CTRL_FLAG_SLIDER
-ignore define V4L2_CTRL_FLAG_WRITE_ONLY
-ignore define V4L2_CTRL_FLAG_VOLATILE
-ignore define V4L2_CTRL_FLAG_HAS_PAYLOAD
-ignore define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE
-ignore define V4L2_CTRL_FLAG_NEXT_CTRL
-ignore define V4L2_CTRL_FLAG_NEXT_COMPOUND
-ignore define V4L2_CID_MAX_CTRLS
-ignore define V4L2_CID_PRIVATE_BASE
-ignore define V4L2_TUNER_CAP_LOW
-ignore define V4L2_TUNER_CAP_NORM
-ignore define V4L2_TUNER_CAP_HWSEEK_BOUNDED
-ignore define V4L2_TUNER_CAP_HWSEEK_WRAP
-ignore define V4L2_TUNER_CAP_STEREO
-ignore define V4L2_TUNER_CAP_LANG2
-ignore define V4L2_TUNER_CAP_SAP
-ignore define V4L2_TUNER_CAP_LANG1
-ignore define V4L2_TUNER_CAP_RDS
-ignore define V4L2_TUNER_CAP_RDS_BLOCK_IO
-ignore define V4L2_TUNER_CAP_RDS_CONTROLS
-ignore define V4L2_TUNER_CAP_FREQ_BANDS
-ignore define V4L2_TUNER_CAP_HWSEEK_PROG_LIM
-ignore define V4L2_TUNER_CAP_1HZ
-ignore define V4L2_TUNER_SUB_MONO
-ignore define V4L2_TUNER_SUB_STEREO
-ignore define V4L2_TUNER_SUB_LANG2
-ignore define V4L2_TUNER_SUB_SAP
-ignore define V4L2_TUNER_SUB_LANG1
-ignore define V4L2_TUNER_SUB_RDS
-ignore define V4L2_TUNER_MODE_MONO
-ignore define V4L2_TUNER_MODE_STEREO
-ignore define V4L2_TUNER_MODE_LANG2
-ignore define V4L2_TUNER_MODE_SAP
-ignore define V4L2_TUNER_MODE_LANG1
-ignore define V4L2_TUNER_MODE_LANG1_LANG2
-ignore define V4L2_BAND_MODULATION_VSB
-ignore define V4L2_BAND_MODULATION_FM
-ignore define V4L2_BAND_MODULATION_AM
-ignore define V4L2_RDS_BLOCK_MSK
-ignore define V4L2_RDS_BLOCK_A
-ignore define V4L2_RDS_BLOCK_B
-ignore define V4L2_RDS_BLOCK_C
-ignore define V4L2_RDS_BLOCK_D
-ignore define V4L2_RDS_BLOCK_C_ALT
-ignore define V4L2_RDS_BLOCK_INVALID
-ignore define V4L2_RDS_BLOCK_CORRECTED
-ignore define V4L2_RDS_BLOCK_ERROR
-ignore define V4L2_AUDCAP_STEREO
-ignore define V4L2_AUDCAP_AVL
-ignore define V4L2_AUDMODE_AVL
-ignore define V4L2_ENC_IDX_FRAME_I
-ignore define V4L2_ENC_IDX_FRAME_P
-ignore define V4L2_ENC_IDX_FRAME_B
-ignore define V4L2_ENC_IDX_FRAME_MASK
-ignore define V4L2_ENC_IDX_ENTRIES
-ignore define V4L2_ENC_CMD_START
-ignore define V4L2_ENC_CMD_STOP
-ignore define V4L2_ENC_CMD_PAUSE
-ignore define V4L2_ENC_CMD_RESUME
-ignore define V4L2_ENC_CMD_STOP_AT_GOP_END
-ignore define V4L2_DEC_CMD_START
-ignore define V4L2_DEC_CMD_STOP
-ignore define V4L2_DEC_CMD_PAUSE
-ignore define V4L2_DEC_CMD_RESUME
-ignore define V4L2_DEC_CMD_START_MUTE_AUDIO
-ignore define V4L2_DEC_CMD_PAUSE_TO_BLACK
-ignore define V4L2_DEC_CMD_STOP_TO_BLACK
-ignore define V4L2_DEC_CMD_STOP_IMMEDIATELY
-ignore define V4L2_DEC_START_FMT_NONE
-ignore define V4L2_DEC_START_FMT_GOP
-ignore define V4L2_VBI_UNSYNC
-ignore define V4L2_VBI_INTERLACED
-ignore define V4L2_VBI_ITU_525_F1_START
-ignore define V4L2_VBI_ITU_525_F2_START
-ignore define V4L2_VBI_ITU_625_F1_START
-ignore define V4L2_VBI_ITU_625_F2_START
-ignore define V4L2_SLICED_TELETEXT_B
-ignore define V4L2_SLICED_VPS
-ignore define V4L2_SLICED_CAPTION_525
-ignore define V4L2_SLICED_WSS_625
-ignore define V4L2_SLICED_VBI_525
-ignore define V4L2_SLICED_VBI_625
-ignore define V4L2_MPEG_VBI_IVTV_TELETEXT_B
-ignore define V4L2_MPEG_VBI_IVTV_CAPTION_525
-ignore define V4L2_MPEG_VBI_IVTV_WSS_625
-ignore define V4L2_MPEG_VBI_IVTV_VPS
-ignore define V4L2_MPEG_VBI_IVTV_MAGIC0
-ignore define V4L2_MPEG_VBI_IVTV_MAGIC1
-ignore define V4L2_EVENT_ALL
-ignore define V4L2_EVENT_VSYNC
-ignore define V4L2_EVENT_EOS
-ignore define V4L2_EVENT_CTRL
-ignore define V4L2_EVENT_FRAME_SYNC
-ignore define V4L2_EVENT_SOURCE_CHANGE
-ignore define V4L2_EVENT_PRIVATE_START
-ignore define V4L2_EVENT_CTRL_CH_VALUE
-ignore define V4L2_EVENT_CTRL_CH_FLAGS
-ignore define V4L2_EVENT_CTRL_CH_RANGE
-ignore define V4L2_EVENT_SRC_CH_RESOLUTION
-ignore define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ
-ignore define V4L2_EVENT_SUB_FL_SEND_INITIAL
-ignore define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK
-ignore define V4L2_CHIP_MATCH_BRIDGE
-ignore define V4L2_CHIP_MATCH_SUBDEV
-ignore define V4L2_CHIP_MATCH_HOST
-ignore define V4L2_CHIP_MATCH_I2C_DRIVER
-ignore define V4L2_CHIP_MATCH_I2C_ADDR
-ignore define V4L2_CHIP_MATCH_AC97
-ignore define V4L2_CHIP_FL_READABLE
-ignore define V4L2_CHIP_FL_WRITABLE
-ignore define BASE_VIDIOC_PRIVATE
+# V4L2 capability defines
+replace define V4L2_CAP_VIDEO_CAPTURE device-capabilities
+replace define V4L2_CAP_VIDEO_CAPTURE_MPLANE device-capabilities
+replace define V4L2_CAP_VIDEO_OUTPUT device-capabilities
+replace define V4L2_CAP_VIDEO_OUTPUT_MPLANE device-capabilities
+replace define V4L2_CAP_VIDEO_M2M device-capabilities
+replace define V4L2_CAP_VIDEO_M2M_MPLANE device-capabilities
+replace define V4L2_CAP_VIDEO_OVERLAY device-capabilities
+replace define V4L2_CAP_VBI_CAPTURE device-capabilities
+replace define V4L2_CAP_VBI_OUTPUT device-capabilities
+replace define V4L2_CAP_SLICED_VBI_CAPTURE device-capabilities
+replace define V4L2_CAP_SLICED_VBI_OUTPUT device-capabilities
+replace define V4L2_CAP_RDS_CAPTURE device-capabilities
+replace define V4L2_CAP_VIDEO_OUTPUT_OVERLAY device-capabilities
+replace define V4L2_CAP_HW_FREQ_SEEK device-capabilities
+replace define V4L2_CAP_RDS_OUTPUT device-capabilities
+replace define V4L2_CAP_TUNER device-capabilities
+replace define V4L2_CAP_AUDIO device-capabilities
+replace define V4L2_CAP_RADIO device-capabilities
+replace define V4L2_CAP_MODULATOR device-capabilities
+replace define V4L2_CAP_SDR_CAPTURE device-capabilities
+replace define V4L2_CAP_EXT_PIX_FORMAT device-capabilities
+replace define V4L2_CAP_SDR_OUTPUT device-capabilities
+replace define V4L2_CAP_READWRITE device-capabilities
+replace define V4L2_CAP_ASYNCIO device-capabilities
+replace define V4L2_CAP_STREAMING device-capabilities
+replace define V4L2_CAP_DEVICE_CAPS device-capabilities
+
+# V4L2 pix flags
+replace define V4L2_PIX_FMT_PRIV_MAGIC v4l2-pix-format
+replace define V4L2_PIX_FMT_FLAG_PREMUL_ALPHA reserved-formats
+
+# V4L2 format flags
+replace define V4L2_FMT_FLAG_COMPRESSED fmtdesc-flags
+replace define V4L2_FMT_FLAG_EMULATED fmtdesc-flags
+
+# V4L2 tymecode types
+replace define V4L2_TC_TYPE_24FPS timecode-type
+replace define V4L2_TC_TYPE_25FPS timecode-type
+replace define V4L2_TC_TYPE_30FPS timecode-type
+replace define V4L2_TC_TYPE_50FPS timecode-type
+replace define V4L2_TC_TYPE_60FPS timecode-type
+
+# V4L2 tymecode flags
+replace define V4L2_TC_FLAG_DROPFRAME timecode-flags
+replace define V4L2_TC_FLAG_COLORFRAME timecode-flags
+replace define V4L2_TC_USERBITS_field timecode-flags
+replace define V4L2_TC_USERBITS_USERDEFINED timecode-flags
+replace define V4L2_TC_USERBITS_8BITCHARS timecode-flags
+
+# V4L2 JPEG markers
+replace define V4L2_JPEG_MARKER_DHT jpeg-markers
+replace define V4L2_JPEG_MARKER_DQT jpeg-markers
+replace define V4L2_JPEG_MARKER_DRI jpeg-markers
+replace define V4L2_JPEG_MARKER_COM jpeg-markers
+replace define V4L2_JPEG_MARKER_APP jpeg-markers
+
+#V4L2 buffer flags
+replace define V4L2_BUF_FLAG_MAPPED buffer-flags
+replace define V4L2_BUF_FLAG_QUEUED buffer-flags
+replace define V4L2_BUF_FLAG_DONE buffer-flags
+replace define V4L2_BUF_FLAG_ERROR buffer-flags
+replace define V4L2_BUF_FLAG_KEYFRAME buffer-flags
+replace define V4L2_BUF_FLAG_PFRAME buffer-flags
+replace define V4L2_BUF_FLAG_BFRAME buffer-flags
+replace define V4L2_BUF_FLAG_TIMECODE buffer-flags
+replace define V4L2_BUF_FLAG_PREPARED buffer-flags
+replace define V4L2_BUF_FLAG_NO_CACHE_INVALIDATE buffer-flags
+replace define V4L2_BUF_FLAG_NO_CACHE_CLEAN buffer-flags
+replace define V4L2_BUF_FLAG_TIMESTAMP_MASK buffer-flags
+replace define V4L2_BUF_FLAG_TIMESTAMP_UNKNOWN buffer-flags
+replace define V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC buffer-flags
+replace define V4L2_BUF_FLAG_TIMESTAMP_COPY buffer-flags
+replace define V4L2_BUF_FLAG_TSTAMP_SRC_MASK buffer-flags
+replace define V4L2_BUF_FLAG_TSTAMP_SRC_EOF buffer-flags
+replace define V4L2_BUF_FLAG_TSTAMP_SRC_SOE buffer-flags
+replace define V4L2_BUF_FLAG_LAST buffer-flags-FIXME
+
+# V4L2 framebuffer caps and flags
+
+replace define V4L2_FBUF_CAP_EXTERNOVERLAY framebuffer-cap
+replace define V4L2_FBUF_CAP_CHROMAKEY framebuffer-cap
+replace define V4L2_FBUF_CAP_LIST_CLIPPING framebuffer-cap
+replace define V4L2_FBUF_CAP_BITMAP_CLIPPING framebuffer-cap
+replace define V4L2_FBUF_CAP_LOCAL_ALPHA framebuffer-cap
+replace define V4L2_FBUF_CAP_GLOBAL_ALPHA framebuffer-cap
+replace define V4L2_FBUF_CAP_LOCAL_INV_ALPHA framebuffer-cap
+replace define V4L2_FBUF_CAP_SRC_CHROMAKEY framebuffer-cap
+
+replace define V4L2_FBUF_FLAG_PRIMARY framebuffer-flags
+replace define V4L2_FBUF_FLAG_OVERLAY framebuffer-flags
+replace define V4L2_FBUF_FLAG_CHROMAKEY framebuffer-flags
+replace define V4L2_FBUF_FLAG_LOCAL_ALPHA framebuffer-flags
+replace define V4L2_FBUF_FLAG_GLOBAL_ALPHA framebuffer-flags
+replace define V4L2_FBUF_FLAG_LOCAL_INV_ALPHA framebuffer-flags
+replace define V4L2_FBUF_FLAG_SRC_CHROMAKEY framebuffer-flags
+
+# Used on VIDIOC_G_PARM
+
+replace define V4L2_MODE_HIGHQUALITY parm-flags
+replace define V4L2_CAP_TIMEPERFRAME v4l2-captureparm
# The V4L2_STD_foo are all defined at v4l2_std_id table
+
replace define V4L2_STD_PAL_B v4l2-std-id
replace define V4L2_STD_PAL_B1 v4l2-std-id
replace define V4L2_STD_PAL_G v4l2-std-id
@@ -442,8 +278,254 @@ replace define V4L2_STD_ATSC v4l2-std-id
replace define V4L2_STD_UNKNOWN v4l2-std-id
replace define V4L2_STD_ALL v4l2-std-id
-# Ignore reserved ioctl
+# V4L2 DT BT timings definitions
+
+replace define V4L2_DV_PROGRESSIVE v4l2-dv-fixme
+replace define V4L2_DV_INTERLACED v4l2-dv-fixme
+
+replace define V4L2_DV_VSYNC_POS_POL v4l2-bt-timings
+replace define V4L2_DV_HSYNC_POS_POL v4l2-bt-timings
+
+replace define V4L2_DV_BT_STD_CEA861 dv-bt-standards
+replace define V4L2_DV_BT_STD_DMT dv-bt-standards
+replace define V4L2_DV_BT_STD_CVT dv-bt-standards
+replace define V4L2_DV_BT_STD_GTF dv-bt-standards
+
+replace define V4L2_DV_FL_REDUCED_BLANKING dv-bt-standards
+replace define V4L2_DV_FL_CAN_REDUCE_FPS dv-bt-standards
+replace define V4L2_DV_FL_REDUCED_FPS dv-bt-standards
+replace define V4L2_DV_FL_HALF_LINE dv-bt-standards
+replace define V4L2_DV_FL_IS_CE_VIDEO dv-bt-standards
+
+replace define V4L2_DV_BT_656_1120 dv-timing-types
+
+replace define V4L2_DV_BT_CAP_INTERLACED framebuffer-cap
+replace define V4L2_DV_BT_CAP_PROGRESSIVE framebuffer-cap
+replace define V4L2_DV_BT_CAP_REDUCED_BLANKING framebuffer-cap
+replace define V4L2_DV_BT_CAP_CUSTOM framebuffer-cap
+
+# V4L2 input
+
+replace define V4L2_INPUT_TYPE_TUNER input-type
+replace define V4L2_INPUT_TYPE_CAMERA input-type
+
+replace define V4L2_IN_ST_NO_POWER input-status
+replace define V4L2_IN_ST_NO_SIGNAL input-status
+replace define V4L2_IN_ST_NO_COLOR input-status
+replace define V4L2_IN_ST_HFLIP input-status
+replace define V4L2_IN_ST_VFLIP input-status
+replace define V4L2_IN_ST_NO_H_LOCK input-status
+replace define V4L2_IN_ST_COLOR_KILL input-status
+replace define V4L2_IN_ST_NO_SYNC input-status
+replace define V4L2_IN_ST_NO_EQU input-status
+replace define V4L2_IN_ST_NO_CARRIER input-status
+replace define V4L2_IN_ST_MACROVISION input-status
+replace define V4L2_IN_ST_NO_ACCESS input-status
+replace define V4L2_IN_ST_VTR input-status
+
+replace define V4L2_IN_CAP_DV_TIMINGS input-capabilities
+replace define V4L2_IN_CAP_STD input-capabilities
+replace define V4L2_IN_CAP_NATIVE_SIZE input-capabilities
+
+# V4L2 output
+
+replace define V4L2_OUTPUT_TYPE_MODULATOR output-type
+replace define V4L2_OUTPUT_TYPE_ANALOG output-type
+replace define V4L2_OUTPUT_TYPE_ANALOGVGAOVERLAY output-type
+
+replace define V4L2_OUT_CAP_DV_TIMINGS output-capabilities
+replace define V4L2_OUT_CAP_STD output-capabilities
+replace define V4L2_OUT_CAP_NATIVE_SIZE output-capabilities
+
+# V4L2 control flags
+
+replace define V4L2_CTRL_FLAG_DISABLED control-flags
+replace define V4L2_CTRL_FLAG_GRABBED control-flags
+replace define V4L2_CTRL_FLAG_READ_ONLY control-flags
+replace define V4L2_CTRL_FLAG_UPDATE control-flags
+replace define V4L2_CTRL_FLAG_INACTIVE control-flags
+replace define V4L2_CTRL_FLAG_SLIDER control-flags
+replace define V4L2_CTRL_FLAG_WRITE_ONLY control-flags
+replace define V4L2_CTRL_FLAG_VOLATILE control-flags
+replace define V4L2_CTRL_FLAG_HAS_PAYLOAD control-flags
+replace define V4L2_CTRL_FLAG_EXECUTE_ON_WRITE control-flags
+
+replace define V4L2_CTRL_FLAG_NEXT_CTRL control
+replace define V4L2_CTRL_FLAG_NEXT_COMPOUND control
+replace define V4L2_CID_PRIVATE_BASE control
+
+# V4L2 tuner
+
+replace define V4L2_TUNER_CAP_LOW tuner-capability
+replace define V4L2_TUNER_CAP_NORM tuner-capability
+replace define V4L2_TUNER_CAP_HWSEEK_BOUNDED tuner-capability
+replace define V4L2_TUNER_CAP_HWSEEK_WRAP tuner-capability
+replace define V4L2_TUNER_CAP_STEREO tuner-capability
+replace define V4L2_TUNER_CAP_LANG2 tuner-capability
+replace define V4L2_TUNER_CAP_SAP tuner-capability
+replace define V4L2_TUNER_CAP_LANG1 tuner-capability
+replace define V4L2_TUNER_CAP_RDS tuner-capability
+replace define V4L2_TUNER_CAP_RDS_BLOCK_IO tuner-capability
+replace define V4L2_TUNER_CAP_RDS_CONTROLS tuner-capability
+replace define V4L2_TUNER_CAP_FREQ_BANDS tuner-capability
+replace define V4L2_TUNER_CAP_HWSEEK_PROG_LIM tuner-capability
+replace define V4L2_TUNER_CAP_1HZ tuner-capability
+
+replace define V4L2_TUNER_SUB_MONO tuner-rxsubchans
+replace define V4L2_TUNER_SUB_STEREO tuner-rxsubchans
+replace define V4L2_TUNER_SUB_LANG2 tuner-rxsubchans
+replace define V4L2_TUNER_SUB_SAP tuner-rxsubchans
+replace define V4L2_TUNER_SUB_LANG1 tuner-rxsubchans
+replace define V4L2_TUNER_SUB_RDS tuner-rxsubchans
+
+replace define V4L2_TUNER_MODE_MONO tuner-audmode
+replace define V4L2_TUNER_MODE_STEREO tuner-audmode
+replace define V4L2_TUNER_MODE_LANG2 tuner-audmode
+replace define V4L2_TUNER_MODE_SAP tuner-audmode
+replace define V4L2_TUNER_MODE_LANG1 tuner-audmode
+replace define V4L2_TUNER_MODE_LANG1_LANG2 tuner-audmode
+
+replace define V4L2_BAND_MODULATION_VSB band-modulation
+replace define V4L2_BAND_MODULATION_FM band-modulation
+replace define V4L2_BAND_MODULATION_AM band-modulation
+
+replace define V4L2_RDS_BLOCK_MSK v4l2-rds-block
+replace define V4L2_RDS_BLOCK_A v4l2-rds-block
+replace define V4L2_RDS_BLOCK_B v4l2-rds-block
+replace define V4L2_RDS_BLOCK_C v4l2-rds-block
+replace define V4L2_RDS_BLOCK_D v4l2-rds-block
+replace define V4L2_RDS_BLOCK_C_ALT v4l2-rds-block
+replace define V4L2_RDS_BLOCK_INVALID v4l2-rds-block
+replace define V4L2_RDS_BLOCK_CORRECTED v4l2-rds-block
+replace define V4L2_RDS_BLOCK_ERROR v4l2-rds-block
+
+# V4L2 audio
+
+replace define V4L2_AUDCAP_STEREO audio-capability
+replace define V4L2_AUDCAP_AVL audio-capability
+
+replace define V4L2_AUDMODE_AVL audio-mode
+
+# MPEG
+
+replace define V4L2_ENC_IDX_FRAME_I v4l2-enc-idx
+replace define V4L2_ENC_IDX_FRAME_P v4l2-enc-idx
+replace define V4L2_ENC_IDX_FRAME_B v4l2-enc-idx
+replace define V4L2_ENC_IDX_FRAME_MASK v4l2-enc-idx
+replace define V4L2_ENC_IDX_ENTRIES v4l2-enc-idx
+
+replace define V4L2_ENC_CMD_START encoder-cmds
+replace define V4L2_ENC_CMD_STOP encoder-cmds
+replace define V4L2_ENC_CMD_PAUSE encoder-cmds
+replace define V4L2_ENC_CMD_RESUME encoder-cmds
+
+replace define V4L2_ENC_CMD_STOP_AT_GOP_END encoder-flags
+
+replace define V4L2_DEC_CMD_START decoder-cmds
+replace define V4L2_DEC_CMD_STOP decoder-cmds
+replace define V4L2_DEC_CMD_PAUSE decoder-cmds
+replace define V4L2_DEC_CMD_RESUME decoder-cmds
+
+replace define V4L2_DEC_CMD_START_MUTE_AUDIO decoder-cmds
+replace define V4L2_DEC_CMD_PAUSE_TO_BLACK decoder-cmds
+replace define V4L2_DEC_CMD_STOP_TO_BLACK decoder-cmds
+replace define V4L2_DEC_CMD_STOP_IMMEDIATELY decoder-cmds
+
+replace define V4L2_DEC_START_FMT_NONE decoder-cmds
+replace define V4L2_DEC_START_FMT_GOP decoder-cmds
+
+# V4L2 VBI
+
+replace define V4L2_VBI_UNSYNC vbifmt-flags
+replace define V4L2_VBI_INTERLACED vbifmt-flags
+
+replace define V4L2_VBI_ITU_525_F1_START v4l2-vbi-format
+replace define V4L2_VBI_ITU_525_F2_START v4l2-vbi-format
+replace define V4L2_VBI_ITU_625_F1_START v4l2-vbi-format
+replace define V4L2_VBI_ITU_625_F2_START v4l2-vbi-format
+
+
+replace define V4L2_SLICED_TELETEXT_B vbi-services
+replace define V4L2_SLICED_VPS vbi-services
+replace define V4L2_SLICED_CAPTION_525 vbi-services
+replace define V4L2_SLICED_WSS_625 vbi-services
+replace define V4L2_SLICED_VBI_525 vbi-services
+replace define V4L2_SLICED_VBI_625 vbi-services
+
+replace define V4L2_MPEG_VBI_IVTV_TELETEXT_B ITV0-Line-Identifier-Constants
+replace define V4L2_MPEG_VBI_IVTV_CAPTION_525 ITV0-Line-Identifier-Constants
+replace define V4L2_MPEG_VBI_IVTV_WSS_625 ITV0-Line-Identifier-Constants
+replace define V4L2_MPEG_VBI_IVTV_VPS ITV0-Line-Identifier-Constants
+
+replace define V4L2_MPEG_VBI_IVTV_MAGIC0 v4l2-mpeg-vbi-fmt-ivtv-magic
+replace define V4L2_MPEG_VBI_IVTV_MAGIC1 v4l2-mpeg-vbi-fmt-ivtv-magic
+
+# V4L2 events
+
+replace define V4L2_EVENT_ALL event-type
+replace define V4L2_EVENT_VSYNC event-type
+replace define V4L2_EVENT_EOS event-type
+replace define V4L2_EVENT_CTRL event-type
+replace define V4L2_EVENT_FRAME_SYNC event-type
+replace define V4L2_EVENT_SOURCE_CHANGE event-type
+replace define V4L2_EVENT_MOTION_DET event-type
+replace define V4L2_EVENT_PRIVATE_START event-type
+
+replace define V4L2_EVENT_CTRL_CH_VALUE ctrl-changes-flags
+replace define V4L2_EVENT_CTRL_CH_FLAGS ctrl-changes-flags
+replace define V4L2_EVENT_CTRL_CH_RANGE ctrl-changes-flags
+
+replace define V4L2_EVENT_SRC_CH_RESOLUTION src-changes-flags
+
+replace define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ v4l2-event-motion-det
+
+replace define V4L2_EVENT_SUB_FL_SEND_INITIAL event-flags
+replace define V4L2_EVENT_SUB_FL_ALLOW_FEEDBACK event-flags
+
+# V4L2 debugging
+replace define V4L2_CHIP_MATCH_BRIDGE vidioc_dbg_g_register
+replace define V4L2_CHIP_MATCH_SUBDEV vidioc_dbg_g_register
+replace define V4L2_CHIP_MATCH_HOST vidioc_dbg_g_register
+replace define V4L2_CHIP_MATCH_I2C_DRIVER vidioc_dbg_g_register
+replace define V4L2_CHIP_MATCH_I2C_ADDR vidioc_dbg_g_register
+replace define V4L2_CHIP_MATCH_AC97 vidioc_dbg_g_register
+
+replace define V4L2_CHIP_FL_READABLE vidioc_dbg_g_register
+replace define V4L2_CHIP_FL_WRITABLE vidioc_dbg_g_register
+
+# Ignore reserved ioctl and ancillary macros
+
+ignore define VIDEO_MAX_FRAME
+ignore define VIDEO_MAX_PLANES
+ignore define v4l2_fourcc
+ignore define v4l2_fourcc_be
+ignore define V4L2_FIELD_HAS_TOP
+ignore define V4L2_FIELD_HAS_BOTTOM
+ignore define V4L2_FIELD_HAS_BOTH
+ignore define V4L2_FIELD_HAS_T_OR_B
+ignore define V4L2_TYPE_IS_MULTIPLANAR
+ignore define V4L2_TYPE_IS_OUTPUT
+ignore define V4L2_TUNER_ADC
+ignore define V4L2_MAP_COLORSPACE_DEFAULT
+ignore define V4L2_MAP_XFER_FUNC_DEFAULT
+ignore define V4L2_MAP_YCBCR_ENC_DEFAULT
+ignore define V4L2_DV_BT_BLANKING_WIDTH
+ignore define V4L2_DV_BT_FRAME_WIDTH
+ignore define V4L2_DV_BT_BLANKING_HEIGHT
+ignore define V4L2_DV_BT_FRAME_HEIGHT
+ignore define V4L2_IN_CAP_CUSTOM_TIMINGS
+ignore define V4L2_CTRL_ID_MASK
+ignore define V4L2_CTRL_ID2CLASS
+ignore define V4L2_CTRL_ID2WHICH
+ignore define V4L2_CTRL_DRIVER_PRIV
+ignore define V4L2_CTRL_MAX_DIMS
+ignore define V4L2_CTRL_WHICH_CUR_VAL
+ignore define V4L2_CTRL_WHICH_DEF_VAL
+ignore define V4L2_OUT_CAP_CUSTOM_TIMINGS
+ignore define V4L2_CID_MAX_CTRLS
+
ignore ioctl VIDIOC_RESERVED
+ignore define BASE_VIDIOC_PRIVATE
# Associate ioctls with their counterparts
replace ioctl VIDIOC_DBG_S_REGISTER vidioc_dbg_g_register
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 51/54] doc-rst: linux_tv/Makefile: Honor quiet mode
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (49 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 50/54] doc-rst: videodev2.h: add cross-references for defines Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 52/54] doc-rst: auto-generate: fixed include "output/*.h.rst" content Mauro Carvalho Chehab
` (3 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
Cleanup the Makefile and handle the V=1 flag and make it
to work when specifying an output directory with O=dir
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/Makefile.sphinx | 2 +-
Documentation/linux_tv/Makefile | 49 +++++++++++++++++++++++++++--------------
2 files changed, 33 insertions(+), 18 deletions(-)
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index 37cec114254e..6a093e4397b4 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -35,7 +35,7 @@ quiet_cmd_sphinx = SPHINX $@
cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2
htmldocs:
- $(MAKE) -C $(srctree)/Documentation/linux_tv $@
+ $(MAKE) BUILDDIR=$(objtree)/$(BUILDDIR) -f $(srctree)/Documentation/linux_tv/Makefile $@
$(call cmd,sphinx,html)
pdfdocs:
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 068e26e0cc6f..639b994a50f6 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -1,32 +1,47 @@
# Generate the *.h.rst files from uAPI headers
-PARSER = ../sphinx/parse-headers.pl
-UAPI = ../../include/uapi/linux
-TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
+PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl
+UAPI = $(srctree)/include/uapi/linux
+SRC_DIR=$(srctree)/Documentation/linux_tv
+
+FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
videodev2.h.rst
+TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
+
htmldocs: ${TARGETS}
-audio.h.rst: ${PARSER} ${UAPI}/dvb/audio.h audio.h.rst.exceptions
- ${PARSER} ${UAPI}/dvb/audio.h $@ audio.h.rst.exceptions
+# Rule to convert a .h file to inline RST documentation
-ca.h.rst: ${PARSER} ${UAPI}/dvb/ca.h ca.h.rst.exceptions
- ${PARSER} ${UAPI}/dvb/ca.h $@ ca.h.rst.exceptions
+gen_rst = \
+ echo ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions; \
+ ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions
-dmx.h.rst: ${PARSER} ${UAPI}/dvb/dmx.h dmx.h.rst.exceptions
- ${PARSER} ${UAPI}/dvb/dmx.h $@ dmx.h.rst.exceptions
+quiet_gen_rst = echo ' PARSE $(patsubst $(srctree)/%,%,$<)'; \
+ ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions
-frontend.h.rst: ${PARSER} ${UAPI}/dvb/frontend.h frontend.h.rst.exceptions
- ${PARSER} ${UAPI}/dvb/frontend.h $@ frontend.h.rst.exceptions
+silent_gen_rst = ${gen_rst}
-net.h.rst: ${PARSER} ${UAPI}/dvb/net.h net.h.rst.exceptions
- ${PARSER} ${UAPI}/dvb/net.h $@ net.h.rst.exceptions
+$(BUILDDIR)/audio.h.rst: ${UAPI}/dvb/audio.h ${PARSER} $(SRC_DIR)/audio.h.rst.exceptions
+ @$($(quiet)gen_rst)
-video.h.rst: ${PARSER} ${UAPI}/dvb/video.h video.h.rst.exceptions
- ${PARSER} ${UAPI}/dvb/video.h $@ video.h.rst.exceptions
+$(BUILDDIR)/ca.h.rst: ${UAPI}/dvb/ca.h ${PARSER} $(SRC_DIR)/ca.h.rst.exceptions
+ @$($(quiet)gen_rst)
-videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} videodev2.h.rst.exceptions
- ${PARSER} ${UAPI}/videodev2.h $@ videodev2.h.rst.exceptions
+$(BUILDDIR)/dmx.h.rst: ${UAPI}/dvb/dmx.h ${PARSER} $(SRC_DIR)/dmx.h.rst.exceptions
+ @$($(quiet)gen_rst)
+
+$(BUILDDIR)/frontend.h.rst: ${UAPI}/dvb/frontend.h ${PARSER} $(SRC_DIR)/frontend.h.rst.exceptions
+ @$($(quiet)gen_rst)
+
+$(BUILDDIR)/net.h.rst: ${UAPI}/dvb/net.h ${PARSER} $(SRC_DIR)/net.h.rst.exceptions
+ @$($(quiet)gen_rst)
+
+$(BUILDDIR)/video.h.rst: ${UAPI}/dvb/video.h ${PARSER} $(SRC_DIR)/video.h.rst.exceptions
+ @$($(quiet)gen_rst)
+
+videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions
+ @$($(quiet)gen_rst)
cleandocs:
-rm ${TARGETS}
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 52/54] doc-rst: auto-generate: fixed include "output/*.h.rst" content
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (50 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 51/54] doc-rst: linux_tv/Makefile: Honor quiet mode Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 53/54] doc-rst: add kernel-include directive Mauro Carvalho Chehab
` (2 subsequent siblings)
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
From: Markus Heiser <markus.heiser@darmarIT.de>
Include auto-generate reST header files. BTW fixed linux_tv/Makefile.
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/linux_tv/Makefile | 7 +++++--
Documentation/linux_tv/media/dvb/audio_h.rst | 6 +-----
Documentation/linux_tv/media/dvb/ca_h.rst | 6 +-----
Documentation/linux_tv/media/dvb/dmx_h.rst | 6 +-----
Documentation/linux_tv/media/dvb/frontend_h.rst | 6 +-----
Documentation/linux_tv/media/dvb/net_h.rst | 6 +-----
Documentation/linux_tv/media/dvb/video_h.rst | 6 +-----
Documentation/linux_tv/media/v4l/videodev.rst | 6 +-----
8 files changed, 12 insertions(+), 37 deletions(-)
diff --git a/Documentation/linux_tv/Makefile b/Documentation/linux_tv/Makefile
index 639b994a50f6..688e37d7b232 100644
--- a/Documentation/linux_tv/Makefile
+++ b/Documentation/linux_tv/Makefile
@@ -9,7 +9,10 @@ FILES = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \
TARGETS := $(addprefix $(BUILDDIR)/, $(FILES))
-htmldocs: ${TARGETS}
+htmldocs: $(BUILDDIR) ${TARGETS}
+
+$(BUILDDIR):
+ $(Q)mkdir -p $@
# Rule to convert a .h file to inline RST documentation
@@ -40,7 +43,7 @@ $(BUILDDIR)/net.h.rst: ${UAPI}/dvb/net.h ${PARSER} $(SRC_DIR)/net.h.rst.exceptio
$(BUILDDIR)/video.h.rst: ${UAPI}/dvb/video.h ${PARSER} $(SRC_DIR)/video.h.rst.exceptions
@$($(quiet)gen_rst)
-videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions
+$(BUILDDIR)/videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} $(SRC_DIR)/videodev2.h.rst.exceptions
@$($(quiet)gen_rst)
cleandocs:
diff --git a/Documentation/linux_tv/media/dvb/audio_h.rst b/Documentation/linux_tv/media/dvb/audio_h.rst
index bdd9a709a125..d87be5e2b022 100644
--- a/Documentation/linux_tv/media/dvb/audio_h.rst
+++ b/Documentation/linux_tv/media/dvb/audio_h.rst
@@ -6,8 +6,4 @@
DVB Audio Header File
*********************
-
-.. toctree::
- :maxdepth: 1
-
- ../../audio.h
+.. include:: ../../../output/audio.h.rst
diff --git a/Documentation/linux_tv/media/dvb/ca_h.rst b/Documentation/linux_tv/media/dvb/ca_h.rst
index a7d22154022b..407f840ae2ee 100644
--- a/Documentation/linux_tv/media/dvb/ca_h.rst
+++ b/Documentation/linux_tv/media/dvb/ca_h.rst
@@ -6,8 +6,4 @@
DVB Conditional Access Header File
**********************************
-
-.. toctree::
- :maxdepth: 1
-
- ../../ca.h
+.. include:: ../../../output/ca.h.rst
diff --git a/Documentation/linux_tv/media/dvb/dmx_h.rst b/Documentation/linux_tv/media/dvb/dmx_h.rst
index baf129dd078b..65ee8f095972 100644
--- a/Documentation/linux_tv/media/dvb/dmx_h.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_h.rst
@@ -6,8 +6,4 @@
DVB Demux Header File
*********************
-
-.. toctree::
- :maxdepth: 1
-
- ../../dmx.h
+.. include:: ../../../output/dmx.h.rst
diff --git a/Documentation/linux_tv/media/dvb/frontend_h.rst b/Documentation/linux_tv/media/dvb/frontend_h.rst
index 7101d6ddd916..97735b241f3c 100644
--- a/Documentation/linux_tv/media/dvb/frontend_h.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_h.rst
@@ -6,8 +6,4 @@
DVB Frontend Header File
************************
-
-.. toctree::
- :maxdepth: 1
-
- ../../frontend.h
+.. include:: ../../../output/frontend.h.rst
diff --git a/Documentation/linux_tv/media/dvb/net_h.rst b/Documentation/linux_tv/media/dvb/net_h.rst
index 09560db4e1c0..5a5a797882f2 100644
--- a/Documentation/linux_tv/media/dvb/net_h.rst
+++ b/Documentation/linux_tv/media/dvb/net_h.rst
@@ -6,8 +6,4 @@
DVB Network Header File
***********************
-
-.. toctree::
- :maxdepth: 1
-
- ../../net.h
+.. include:: ../../../output/net.h.rst
diff --git a/Documentation/linux_tv/media/dvb/video_h.rst b/Documentation/linux_tv/media/dvb/video_h.rst
index 45c12d295523..9d649a7e0f8b 100644
--- a/Documentation/linux_tv/media/dvb/video_h.rst
+++ b/Documentation/linux_tv/media/dvb/video_h.rst
@@ -6,8 +6,4 @@
DVB Video Header File
*********************
-
-.. toctree::
- :maxdepth: 1
-
- ../../video.h
+.. include:: ../../../output/video.h.rst
diff --git a/Documentation/linux_tv/media/v4l/videodev.rst b/Documentation/linux_tv/media/v4l/videodev.rst
index 4826416b2ab4..82bac4a0b760 100644
--- a/Documentation/linux_tv/media/v4l/videodev.rst
+++ b/Documentation/linux_tv/media/v4l/videodev.rst
@@ -6,8 +6,4 @@
Video For Linux Two Header File
*******************************
-
-.. toctree::
- :maxdepth: 1
-
- ../../videodev2.h
+.. include:: ../../../output/videodev2.h.rst
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 53/54] doc-rst: add kernel-include directive
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (51 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 52/54] doc-rst: auto-generate: fixed include "output/*.h.rst" content Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 54/54] doc-rst: linux_tv/Makefile: Honor quiet make O=dir Mauro Carvalho Chehab
2016-07-08 13:10 ` [PATCH 00/54] Second series of ReST convert patches for media Hans Verkuil
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
From: Markus Heiser <markus.heiser@darmarIT.de>
The kernel-include directive is needed to include the auto generated rst
content from a build (pre-) process. E.g. the linux_tv Makefile
generates intermediate reST-files from header files. Since there is a O=
option:
make O=dir [targets] Locate all output files in "dir"
We need to include intermediate reST files from arbitrary (O=/tmp/foo)
locations:
The 'kernel-include' reST-directive is a replacement for the 'include'
directive. The 'kernel-include' directive expand environment variables
in the path name and allows to include files from arbitrary locations.
.. hint::
Including files from arbitrary locations (e.g. from '/etc') is a
security risk for builders. This is why the 'include' directive from
docutils *prohibit* pathnames pointing to locations *above* the
filesystem tree where the reST document with the include directive is
placed.
Substrings of the form $name or ${name} are replaced by the value of
environment variable name. Malformed variable names and references to
non-existing variables are left unchanged.
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/sphinx/kernel_include.py | 183 +++++++++++++++++++++++++++++++++
1 file changed, 183 insertions(+)
create mode 100755 Documentation/sphinx/kernel_include.py
diff --git a/Documentation/sphinx/kernel_include.py b/Documentation/sphinx/kernel_include.py
new file mode 100755
index 000000000000..db5738238733
--- /dev/null
+++ b/Documentation/sphinx/kernel_include.py
@@ -0,0 +1,183 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8; mode: python -*-
+# pylint: disable=R0903, C0330, R0914, R0912, E0401
+
+u"""
+ kernel-include
+ ~~~~~~~~~~~~~~
+
+ Implementation of the ``kernel-include`` reST-directive.
+
+ :copyright: Copyright (C) 2016 Markus Heiser
+ :license: GPL Version 2, June 1991 see linux/COPYING for details.
+
+ The ``kernel-include`` reST-directive is a replacement for the ``include``
+ directive. The ``kernel-include`` directive expand environment variables in
+ the path name and allows to include files from arbitrary locations.
+
+ .. hint::
+
+ Including files from arbitrary locations (e.g. from ``/etc``) is a
+ security risk for builders. This is why the ``include`` directive from
+ docutils *prohibit* pathnames pointing to locations *above* the filesystem
+ tree where the reST document with the include directive is placed.
+
+ Substrings of the form $name or ${name} are replaced by the value of
+ environment variable name. Malformed variable names and references to
+ non-existing variables are left unchanged.
+"""
+
+# ==============================================================================
+# imports
+# ==============================================================================
+
+import os.path
+
+from docutils import io, nodes, statemachine
+from docutils.utils.error_reporting import SafeString, ErrorString
+from docutils.parsers.rst import directives
+from docutils.parsers.rst.directives.body import CodeBlock, NumberLines
+from docutils.parsers.rst.directives.misc import Include
+
+# ==============================================================================
+def setup(app):
+# ==============================================================================
+
+ app.add_directive("kernel-include", KernelInclude)
+
+# ==============================================================================
+class KernelInclude(Include):
+# ==============================================================================
+
+ u"""KernelInclude (``kernel-include``) directive"""
+
+ def run(self):
+ path = os.path.realpath(
+ os.path.expandvars(self.arguments[0]))
+
+ # to get a bit security back, prohibit /etc:
+ if path.startswith(os.sep + "etc"):
+ raise self.severe(
+ 'Problems with "%s" directive, prohibited path: %s'
+ % (self.name, path))
+
+ self.arguments[0] = path
+
+ #return super(KernelInclude, self).run() # won't work, see HINTs in _run()
+ return self._run()
+
+ def _run(self):
+ """Include a file as part of the content of this reST file."""
+
+ # HINT: I had to copy&paste the whole Include.run method. I'am not happy
+ # with this, but due to security reasons, the Include.run method does
+ # not allow absolute or relative pathnames pointing to locations *above*
+ # the filesystem tree where the reST document is placed.
+
+ if not self.state.document.settings.file_insertion_enabled:
+ raise self.warning('"%s" directive disabled.' % self.name)
+ source = self.state_machine.input_lines.source(
+ self.lineno - self.state_machine.input_offset - 1)
+ source_dir = os.path.dirname(os.path.abspath(source))
+ path = directives.path(self.arguments[0])
+ if path.startswith('<') and path.endswith('>'):
+ path = os.path.join(self.standard_include_path, path[1:-1])
+ path = os.path.normpath(os.path.join(source_dir, path))
+
+ # HINT: this is the only line I had to change / commented out:
+ #path = utils.relative_path(None, path)
+
+ path = nodes.reprunicode(path)
+ encoding = self.options.get(
+ 'encoding', self.state.document.settings.input_encoding)
+ e_handler=self.state.document.settings.input_encoding_error_handler
+ tab_width = self.options.get(
+ 'tab-width', self.state.document.settings.tab_width)
+ try:
+ self.state.document.settings.record_dependencies.add(path)
+ include_file = io.FileInput(source_path=path,
+ encoding=encoding,
+ error_handler=e_handler)
+ except UnicodeEncodeError as error:
+ raise self.severe('Problems with "%s" directive path:\n'
+ 'Cannot encode input file path "%s" '
+ '(wrong locale?).' %
+ (self.name, SafeString(path)))
+ except IOError as error:
+ raise self.severe('Problems with "%s" directive path:\n%s.' %
+ (self.name, ErrorString(error)))
+ startline = self.options.get('start-line', None)
+ endline = self.options.get('end-line', None)
+ try:
+ if startline or (endline is not None):
+ lines = include_file.readlines()
+ rawtext = ''.join(lines[startline:endline])
+ else:
+ rawtext = include_file.read()
+ except UnicodeError as error:
+ raise self.severe('Problem with "%s" directive:\n%s' %
+ (self.name, ErrorString(error)))
+ # start-after/end-before: no restrictions on newlines in match-text,
+ # and no restrictions on matching inside lines vs. line boundaries
+ after_text = self.options.get('start-after', None)
+ if after_text:
+ # skip content in rawtext before *and incl.* a matching text
+ after_index = rawtext.find(after_text)
+ if after_index < 0:
+ raise self.severe('Problem with "start-after" option of "%s" '
+ 'directive:\nText not found.' % self.name)
+ rawtext = rawtext[after_index + len(after_text):]
+ before_text = self.options.get('end-before', None)
+ if before_text:
+ # skip content in rawtext after *and incl.* a matching text
+ before_index = rawtext.find(before_text)
+ if before_index < 0:
+ raise self.severe('Problem with "end-before" option of "%s" '
+ 'directive:\nText not found.' % self.name)
+ rawtext = rawtext[:before_index]
+
+ include_lines = statemachine.string2lines(rawtext, tab_width,
+ convert_whitespace=True)
+ if 'literal' in self.options:
+ # Convert tabs to spaces, if `tab_width` is positive.
+ if tab_width >= 0:
+ text = rawtext.expandtabs(tab_width)
+ else:
+ text = rawtext
+ literal_block = nodes.literal_block(rawtext, source=path,
+ classes=self.options.get('class', []))
+ literal_block.line = 1
+ self.add_name(literal_block)
+ if 'number-lines' in self.options:
+ try:
+ startline = int(self.options['number-lines'] or 1)
+ except ValueError:
+ raise self.error(':number-lines: with non-integer '
+ 'start value')
+ endline = startline + len(include_lines)
+ if text.endswith('\n'):
+ text = text[:-1]
+ tokens = NumberLines([([], text)], startline, endline)
+ for classes, value in tokens:
+ if classes:
+ literal_block += nodes.inline(value, value,
+ classes=classes)
+ else:
+ literal_block += nodes.Text(value, value)
+ else:
+ literal_block += nodes.Text(text, text)
+ return [literal_block]
+ if 'code' in self.options:
+ self.options['source'] = path
+ codeblock = CodeBlock(self.name,
+ [self.options.pop('code')], # arguments
+ self.options,
+ include_lines, # content
+ self.lineno,
+ self.content_offset,
+ self.block_text,
+ self.state,
+ self.state_machine)
+ return codeblock.run()
+ self.state_machine.insert_input(include_lines, path)
+ return []
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* [PATCH 54/54] doc-rst: linux_tv/Makefile: Honor quiet make O=dir
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (52 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 53/54] doc-rst: add kernel-include directive Mauro Carvalho Chehab
@ 2016-07-08 13:03 ` Mauro Carvalho Chehab
2016-07-08 13:10 ` [PATCH 00/54] Second series of ReST convert patches for media Hans Verkuil
54 siblings, 0 replies; 56+ messages in thread
From: Mauro Carvalho Chehab @ 2016-07-08 13:03 UTC (permalink / raw)
To: Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab,
Mauro Carvalho Chehab
From: Markus Heiser <markus.heiser@darmarIT.de>
To honor the:
make O=dir [targets] Locate all output files in "dir"
* activate kernel-include directive
* export BUILDDIR=$(BUILDDIR)
* linux_tv: replace '.. include::' with '.. kernel-include:: $BUILDDIR/<foo.h.rst>'
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/Makefile.sphinx | 4 ++--
Documentation/conf.py | 2 +-
Documentation/linux_tv/media/dvb/audio_h.rst | 4 +++-
Documentation/linux_tv/media/dvb/ca_h.rst | 2 +-
Documentation/linux_tv/media/dvb/dmx_h.rst | 2 +-
Documentation/linux_tv/media/dvb/frontend_h.rst | 2 +-
Documentation/linux_tv/media/dvb/net_h.rst | 2 +-
Documentation/linux_tv/media/dvb/video_h.rst | 2 +-
Documentation/linux_tv/media/v4l/videodev.rst | 2 +-
9 files changed, 12 insertions(+), 10 deletions(-)
diff --git a/Documentation/Makefile.sphinx b/Documentation/Makefile.sphinx
index 6a093e4397b4..5aa2161fc3df 100644
--- a/Documentation/Makefile.sphinx
+++ b/Documentation/Makefile.sphinx
@@ -32,10 +32,10 @@ ALLSPHINXOPTS = -D version=$(KERNELVERSION) -D release=$(KERNELRELEASE) -d $(B
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
quiet_cmd_sphinx = SPHINX $@
- cmd_sphinx = $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2
+ cmd_sphinx = BUILDDIR=$(BUILDDIR) $(SPHINXBUILD) -b $2 $(ALLSPHINXOPTS) $(BUILDDIR)/$2
htmldocs:
- $(MAKE) BUILDDIR=$(objtree)/$(BUILDDIR) -f $(srctree)/Documentation/linux_tv/Makefile $@
+ $(MAKE) BUILDDIR=$(BUILDDIR) -f $(srctree)/Documentation/linux_tv/Makefile $@
$(call cmd,sphinx,html)
pdfdocs:
diff --git a/Documentation/conf.py b/Documentation/conf.py
index f35748b4bc26..224240b5bc50 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -28,7 +28,7 @@ sys.path.insert(0, os.path.abspath('sphinx'))
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ['kernel-doc', 'rstFlatTable']
+extensions = ['kernel-doc', 'rstFlatTable', 'kernel_include']
# Gracefully handle missing rst2pdf.
try:
diff --git a/Documentation/linux_tv/media/dvb/audio_h.rst b/Documentation/linux_tv/media/dvb/audio_h.rst
index d87be5e2b022..0ea0b41b20ae 100644
--- a/Documentation/linux_tv/media/dvb/audio_h.rst
+++ b/Documentation/linux_tv/media/dvb/audio_h.rst
@@ -6,4 +6,6 @@
DVB Audio Header File
*********************
-.. include:: ../../../output/audio.h.rst
+.. kernel-include:: $BUILDDIR/audio.h.rst
+
+.. kernel-include:: $BUILDDIR/../../../../etc/adduser.conf
diff --git a/Documentation/linux_tv/media/dvb/ca_h.rst b/Documentation/linux_tv/media/dvb/ca_h.rst
index 407f840ae2ee..f513592ef529 100644
--- a/Documentation/linux_tv/media/dvb/ca_h.rst
+++ b/Documentation/linux_tv/media/dvb/ca_h.rst
@@ -6,4 +6,4 @@
DVB Conditional Access Header File
**********************************
-.. include:: ../../../output/ca.h.rst
+.. kernel-include:: $BUILDDIR/ca.h.rst
diff --git a/Documentation/linux_tv/media/dvb/dmx_h.rst b/Documentation/linux_tv/media/dvb/dmx_h.rst
index 65ee8f095972..4fd1704a0833 100644
--- a/Documentation/linux_tv/media/dvb/dmx_h.rst
+++ b/Documentation/linux_tv/media/dvb/dmx_h.rst
@@ -6,4 +6,4 @@
DVB Demux Header File
*********************
-.. include:: ../../../output/dmx.h.rst
+.. kernel-include:: $BUILDDIR/dmx.h.rst
diff --git a/Documentation/linux_tv/media/dvb/frontend_h.rst b/Documentation/linux_tv/media/dvb/frontend_h.rst
index 97735b241f3c..15fca04d1c32 100644
--- a/Documentation/linux_tv/media/dvb/frontend_h.rst
+++ b/Documentation/linux_tv/media/dvb/frontend_h.rst
@@ -6,4 +6,4 @@
DVB Frontend Header File
************************
-.. include:: ../../../output/frontend.h.rst
+.. kernel-include:: $BUILDDIR/frontend.h.rst
diff --git a/Documentation/linux_tv/media/dvb/net_h.rst b/Documentation/linux_tv/media/dvb/net_h.rst
index 5a5a797882f2..7bcf5ba9d1eb 100644
--- a/Documentation/linux_tv/media/dvb/net_h.rst
+++ b/Documentation/linux_tv/media/dvb/net_h.rst
@@ -6,4 +6,4 @@
DVB Network Header File
***********************
-.. include:: ../../../output/net.h.rst
+.. kernel-include:: $BUILDDIR/net.h.rst
diff --git a/Documentation/linux_tv/media/dvb/video_h.rst b/Documentation/linux_tv/media/dvb/video_h.rst
index 9d649a7e0f8b..3f39b0c4879c 100644
--- a/Documentation/linux_tv/media/dvb/video_h.rst
+++ b/Documentation/linux_tv/media/dvb/video_h.rst
@@ -6,4 +6,4 @@
DVB Video Header File
*********************
-.. include:: ../../../output/video.h.rst
+.. kernel-include:: $BUILDDIR/video.h.rst
diff --git a/Documentation/linux_tv/media/v4l/videodev.rst b/Documentation/linux_tv/media/v4l/videodev.rst
index 82bac4a0b760..b9ee4672d639 100644
--- a/Documentation/linux_tv/media/v4l/videodev.rst
+++ b/Documentation/linux_tv/media/v4l/videodev.rst
@@ -6,4 +6,4 @@
Video For Linux Two Header File
*******************************
-.. include:: ../../../output/videodev2.h.rst
+.. kernel-include:: $BUILDDIR/videodev2.h.rst
--
2.7.4
^ permalink raw reply related [flat|nested] 56+ messages in thread
* Re: [PATCH 00/54] Second series of ReST convert patches for media
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
` (53 preceding siblings ...)
2016-07-08 13:03 ` [PATCH 54/54] doc-rst: linux_tv/Makefile: Honor quiet make O=dir Mauro Carvalho Chehab
@ 2016-07-08 13:10 ` Hans Verkuil
54 siblings, 0 replies; 56+ messages in thread
From: Hans Verkuil @ 2016-07-08 13:10 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Media Mailing List
Cc: corbet, markus.heiser, linux-doc, Mauro Carvalho Chehab
On 07/08/2016 03:02 PM, Mauro Carvalho Chehab wrote:
> That's the second series of patches related to DocBook to ReST
> conversion. With this patch series, we're ready to merge it
> upstream.
>
> There are still one thing to do: there are some new updates at
> the DocBook pages on two topic branches (cec and vsp1). Those
> changes should also be converted, in order to be able to remove
> the DocBook pages.
>
> Visually, I'm more happy with the new pages, as the produced
> layout is more fancy, IMHO, using a modern visual.
>
> Also, editing ReST pages is a way simpler than editing the
> DocBooks. Also, reviewing documentation patches should be
> simpler, with is a good thing.
>
> On the bad side, Sphinx doesn't support auto-numberating
> examples, figures or tables. We'll need some extension for
> that. For now, the only impact is on the examples, that were
> manually numerated. So, patches adding new examples will need
> to check and manually renumerate other examples.
>
> I hope we'll have soon some Sphinx extension to support
> auto-numbering.
>
> I'll soon change linux.org documentation page to show the
> Sphinx-generated documenation. I intend to keep the old
> one for a while, for people to be able to compare both.
> I'll post an email once I do this at both linux-media and
> linux-doc mailing lists.
>
> I did a review on all pages, but, as I'm not a Vulcan,
> I'm pretty sure I missed some things. So, feel free to
> review the final document and send me patches with any
> needed fixes or improvements.
>
> Finally, you'll see some warnings produced by generating
> the documentation.
>
> There are actually two types of warnings there:
>
> 1) At least here where I sit, I'm getting those warnings:
>
> Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst:18: WARNING: Error when parsing function declaration:
Can we please put this in Documentation/media instead of linux_tv? That's a really
bad name, and not logical at all since the drivers are all in drivers/media.
Someone looking for the drivers/media documentation won't be able to find it.
I know I had to look in the actual patches to discover that it ended up in linux_tv!
Regards,
Hans
^ permalink raw reply [flat|nested] 56+ messages in thread
end of thread, other threads:[~2016-07-08 13:10 UTC | newest]
Thread overview: 56+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-07-08 13:02 [PATCH 00/54] Second series of ReST convert patches for media Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 01/54] doc-rst: linux_tv: split DVB function call documentation Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 02/54] doc-rst: linux_tv: reformat all syscall pages Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 03/54] doc-rst: linux_tv: dvb: use lowercase for filenames Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 04/54] doc-rst: linux_tv: dvb: put return value at the end Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 05/54] doc-rst: boilerplate HTML theme customization Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 06/54] doc-rst: remove Documentation/linux_tv/conf.py file Mauro Carvalho Chehab
2016-07-08 13:02 ` [PATCH 07/54] doc-rst: customize RTD theme, table & full width Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 08/54] doc-rst: customize RTD theme, captions & inline literal Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 09/54] doc-rst: linux_tv: don't use uppercases for syscall sections Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 10/54] doc-rst: linux_tv: use :cpp:function:: on all syscalls Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 11/54] doc-rst: dmabuf: Fix the cross-reference Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 12/54] doc-rst: dev-overlay: fix the last warning Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 13/54] doc-rst: dvbapi: Fix conversion issues Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 14/54] doc-rst: fix intro_files/dvbstb.png image Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 15/54] doc-rst: dvb/intro: Better show the needed include blocks Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 16/54] doc-rst: intro: remove obsolete headers Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 17/54] doc-rst: media-controller: fix conversion issues Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 18/54] doc-rst: media-controller: missing credits Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 19/54] doc-rst: media-controller.rst: add missing copy symbol Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 20/54] doc-rst: media-controller-model: fix a typo Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 21/54] doc-rst: mediactl: fix some wrong cross references Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 22/54] doc-rst: media-ioc-g-topology: Fix tables Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 23/54] doc-rst: media-ioc-enum-entities: better format the table Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 24/54] doc-rst: gen-errors: Improve table layout Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 25/54] doc-rst: remote_controllers: fix conversion issues Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 26/54] doc-rst: Rename the title of the Digital TV section Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 27/54] doc-rst: v4l2: Rename the V4L2 API title Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 28/54] doc-rst: linux_tv/index: Rename the book name Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 29/54] doc-rst: add parse-headers.pl script Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 30/54] doc-rst: auto-build the frontend.h.rst Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 31/54] doc-rst: parse-headers: improve delimiters to detect symbols Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 32/54] doc-dst: parse-headers: highlight deprecated comments Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 33/54] doc-rst: fix parsing comments and '{' on a separate line Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 34/54] doc-rst: parse-headers: be more formal about the valid symbols Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 35/54] doc-rst: parse-headers: better handle typedefs Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 36/54] doc-rst: parse-headers: fix multiline typedef handler Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 37/54] doc-rst: auto-generate dmx.h.rst Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 38/54] doc-rst: auto-generate audio.h.rst Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 39/54] doc-rst: auto-generate ca.h.rst Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 40/54] doc-rst: auto-generate net.h.rst Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 41/54] doc-rst: auto-generate video.h.rst Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 42/54] doc-rst: parse-headers: better handle comments at the source code Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 43/54] doc-rst: parse-headers: add an option to ignore enum symbols Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 44/54] doc-rst: parse-headers: don't do substituition references Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 45/54] doc-rst: autogenerate videodev2.h.rst file Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 46/54] doc-rst: fix some badly converted references Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 47/54] doc-rst: linux_tv: Don't ignore pix formats Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 48/54] doc-rst: videodev2.h: don't ignore V4L2_STD macros Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 49/54] doc-rst: document enum symbols Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 50/54] doc-rst: videodev2.h: add cross-references for defines Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 51/54] doc-rst: linux_tv/Makefile: Honor quiet mode Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 52/54] doc-rst: auto-generate: fixed include "output/*.h.rst" content Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 53/54] doc-rst: add kernel-include directive Mauro Carvalho Chehab
2016-07-08 13:03 ` [PATCH 54/54] doc-rst: linux_tv/Makefile: Honor quiet make O=dir Mauro Carvalho Chehab
2016-07-08 13:10 ` [PATCH 00/54] Second series of ReST convert patches for media Hans Verkuil
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox