Second series of ReST convert patches for media
Subsystems (3)
cover Second series of ReST convert patches for media
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.plSignature · 1 line
2.7.4
PATCH 1/54 doc-rst: linux_tv: split DVB function call documentation
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 <[email protected]>
--- .../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
Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst new file +59 -0
@@ -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. + +
Documentation/linux_tv/media/dvb/audio-channel-select.rst new file +58 -0
58 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-clear-buffer.rst new file +49 -0
49 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-continue.rst new file +49 -0
49 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-fclose.rst new file +52 -0
52 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-fopen.rst new file +102 -0
102 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-fwrite.rst new file +80 -0
80 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-get-capabilities.rst new file +55 -0
55 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-get-pts.rst new file +64 -0
64 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-get-status.rst new file +55 -0
55 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-pause.rst new file +50 -0
50 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-play.rst new file +49 -0
49 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-select-source.rst new file +57 -0
57 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-attributes.rst new file +69 -0
69 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-av-sync.rst new file +65 -0
65 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst new file +69 -0
69 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-ext-id.rst new file +69 -0
69 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-id.rst new file +60 -0
60 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-karaoke.rst new file +65 -0
65 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-mixer.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-mute.rst new file +69 -0
69 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-set-streamtype.rst new file +70 -0
70 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-stop.rst new file +49 -0
49 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio_function_calls.rst +26 -1373
1,402 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-fclose.rst new file +52 -0
52 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-fopen.rst new file +107 -0
107 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-get-cap.rst new file +54 -0
21 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-get-descr-info.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-get-msg.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-get-slot-info.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-reset.rst new file +48 -0
48 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-send-msg.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-set-descr.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-set-pid.rst new file +52 -0
52 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca_function_calls.rst +13 -564
577 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-add-pid.rst new file +56 -0
56 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-fclose.rst new file +53 -0
53 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-fopen.rst new file +106 -0
106 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-fread.rst new file +106 -0
106 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-fwrite.rst new file +87 -0
87 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-get-caps.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-get-event.rst new file +72 -0
72 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-get-stc.rst new file +73 -0
73 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-remove-pid.rst new file +55 -0
55 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst new file +57 -0
57 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-set-filter.rst new file +63 -0
63 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst new file +74 -0
74 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-set-source.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-start.rst new file +73 -0
73 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-stop.rst new file +50 -0
50 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx_fcalls.rst +19 -1056
1,075 lines not on this page · raw message
Documentation/linux_tv/media/dvb/net-add-if.rst new file +87 -0
87 lines not on this page · raw message
Documentation/linux_tv/media/dvb/net-get-if.rst new file +48 -0
48 lines not on this page · raw message
Documentation/linux_tv/media/dvb/net-remove-if.rst new file +42 -0
42 lines not on this page · raw message
Documentation/linux_tv/media/dvb/net.rst +5 -175
180 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-clear-buffer.rst new file +49 -0
49 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-command.rst new file +61 -0
61 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-continue.rst new file +52 -0
52 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-fast-forward.rst new file +70 -0
70 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-fclose.rst new file +52 -0
52 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-fopen.rst new file +108 -0
108 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-freeze.rst new file +56 -0
56 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-fwrite.rst new file +80 -0
80 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-capabilities.rst new file +56 -0
56 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-event.rst new file +86 -0
86 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-frame-count.rst new file +60 -0
60 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-frame-rate.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-navi.rst new file +70 -0
70 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-pts.rst new file +64 -0
64 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-size.rst new file +54 -0
54 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-status.rst new file +55 -0
55 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-play.rst new file +52 -0
52 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-select-source.rst new file +60 -0
60 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-attributes.rst new file +68 -0
68 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-blank.rst new file +59 -0
59 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-display-format.rst new file +55 -0
55 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-format.rst new file +70 -0
70 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-highlight.rst new file +55 -0
55 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-id.rst new file +69 -0
69 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-spu-palette.rst new file +68 -0
68 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-spu.rst new file +70 -0
70 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-streamtype.rst new file +56 -0
56 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-set-system.rst new file +71 -0
71 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-slowmotion.rst new file +70 -0
70 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-stillpicture.rst new file +56 -0
56 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-stop.rst new file +69 -0
69 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-try-command.rst new file +61 -0
61 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video_function_calls.rst +35 -1973
2,008 lines not on this page · raw message
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.7.4
Part of the diff is not shown here. View the raw message.
PATCH 2/54 doc-rst: linux_tv: reformat all syscall pages
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- .../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(-)
Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst +22 -17
@@ -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
Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst +19 -14
@@ -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
Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst +16 -11
@@ -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
Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst +17 -12
@@ -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
Documentation/linux_tv/media/dvb/FE_READ_SNR.rst +17 -12
@@ -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
Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst +19 -14
@@ -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
Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst +23 -18
59 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst +19 -15
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-channel-select.rst +18 -14
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-clear-buffer.rst +15 -11
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-continue.rst +15 -11
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-fclose.rst +14 -13
@@ -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. - - -
Documentation/linux_tv/media/dvb/audio-fopen.rst +55 -54
130 lines not on this page · raw message
Documentation/linux_tv/media/dvb/audio-fwrite.rst +18 -17
@@ -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. - - -
Documentation/linux_tv/media/dvb/audio-get-capabilities.rst +15 -11
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-get-pts.rst +19 -15
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-get-status.rst +15 -11
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-pause.rst +16 -12
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-play.rst +15 -11
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-select-source.rst +17 -13
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-set-attributes.rst +15 -12
@@ -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. - - -
Documentation/linux_tv/media/dvb/audio-set-av-sync.rst +15 -11
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst +18 -14
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-set-ext-id.rst +15 -12
@@ -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. - - -
Documentation/linux_tv/media/dvb/audio-set-id.rst +20 -16
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-set-karaoke.rst +14 -8
@@ -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
Documentation/linux_tv/media/dvb/audio-set-mixer.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-set-mute.rst +19 -15
@@ -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. - -
Documentation/linux_tv/media/dvb/audio-set-streamtype.rst +16 -13
@@ -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. - - -
Documentation/linux_tv/media/dvb/audio-stop.rst +15 -11
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-fclose.rst +14 -13
@@ -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. - - -
Documentation/linux_tv/media/dvb/ca-fopen.rst +25 -24
76 lines not on this page · raw message
Documentation/linux_tv/media/dvb/ca-get-cap.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-get-descr-info.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-get-msg.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-get-slot-info.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-reset.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-send-msg.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-set-descr.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/ca-set-pid.rst +14 -8
@@ -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
Documentation/linux_tv/media/dvb/dmx-add-pid.rst +16 -12
@@ -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. - -
Documentation/linux_tv/media/dvb/dmx-fclose.rst +15 -14
@@ -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. - - -
Documentation/linux_tv/media/dvb/dmx-fopen.rst +50 -49
120 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-fread.rst +17 -16
@@ -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. - - -
Documentation/linux_tv/media/dvb/dmx-fwrite.rst +19 -18
@@ -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. - - -
Documentation/linux_tv/media/dvb/dmx-get-caps.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/dmx-get-event.rst +18 -15
@@ -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. - - -
Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst +14 -10
@@ -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. - -
Documentation/linux_tv/media/dvb/dmx-get-stc.rst +19 -16
@@ -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. - - -
Documentation/linux_tv/media/dvb/dmx-remove-pid.rst +17 -11
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst +17 -13
@@ -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. - -
Documentation/linux_tv/media/dvb/dmx-set-filter.rst +23 -19
66 lines not on this page · raw message
Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst +17 -14
@@ -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. - - -
Documentation/linux_tv/media/dvb/dmx-set-source.rst +14 -10
@@ -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 ------------
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/dmx-start.rst +15 -12
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/dmx-stop.rst +16 -12
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst +9 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst +9 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-get-info.rst +9 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-get-property.rst +9 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-read-status.rst +9 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-set-tone.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/fe-set-voltage.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/frontend_f_close.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/frontend_f_open.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/net-add-if.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/net-get-if.rst +9 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/net-remove-if.rst +9 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-clear-buffer.rst +15 -11
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-command.rst +21 -17
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-continue.rst +18 -14
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-fast-forward.rst +16 -13
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-fclose.rst +14 -13
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-fopen.rst +55 -52
107 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-freeze.rst +22 -18
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-fwrite.rst +18 -17
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-capabilities.rst +16 -12
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-event.rst +41 -38
79 lines not on this page · raw message
Documentation/linux_tv/media/dvb/video-get-frame-count.rst +19 -15
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-frame-rate.rst +14 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-navi.rst +16 -13
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-pts.rst +19 -15
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-size.rst +14 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-status.rst +15 -11
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-play.rst +18 -14
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-select-source.rst +20 -16
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-attributes.rst +17 -11
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-blank.rst +14 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-display-format.rst +15 -11
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-format.rst +16 -13
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-highlight.rst +15 -11
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-id.rst +15 -12
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-spu-palette.rst +14 -11
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-spu.rst +15 -12
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-streamtype.rst +16 -12
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-system.rst +17 -14
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-slowmotion.rst +16 -13
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-stillpicture.rst +16 -12
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-stop.rst +19 -15
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-try-command.rst +21 -17
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-func-close.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-func-ioctl.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-func-open.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-close.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-ioctl.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-mmap.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-munmap.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-open.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-poll.rst +12 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-read.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-select.rst +12 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-write.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-cropcap.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dqevent.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enuminput.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumstd.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-audio.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst +8 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst +8 -11
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst +8 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst +8 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-input.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-output.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-priority.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-selection.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-std.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-log-status.rst +12 -6
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-overlay.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-querybuf.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-querycap.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst +8 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-querystd.rst +8 -7
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-streamon.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst +8 -8
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst +8 -10
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst +8 -9
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst +8 -9
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.7.4
Part of the diff is not shown here. View the raw message.
PATCH 3/54 doc-rst: linux_tv: dvb: use lowercase for filenames
In reply to Mauro Carvalho ChehabThere 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 <[email protected]>
---
...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%)Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst renamed from Documentation/linux_tv/media/dvb/FE_DISHNETWORK_SEND_LEGACY_CMD.rst +0 -0
Documentation/linux_tv/media/dvb/fe-get-event.rst renamed from Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst +0 -0
Documentation/linux_tv/media/dvb/fe-get-frontend.rst renamed from Documentation/linux_tv/media/dvb/FE_GET_FRONTEND.rst +0 -0
Documentation/linux_tv/media/dvb/fe-read-ber.rst renamed from Documentation/linux_tv/media/dvb/FE_READ_BER.rst +0 -0
Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst renamed from Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst +0 -0
Documentation/linux_tv/media/dvb/fe-read-snr.rst renamed from Documentation/linux_tv/media/dvb/FE_READ_SNR.rst +0 -0
Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst renamed from Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst +0 -0
Documentation/linux_tv/media/dvb/fe-set-frontend.rst renamed from Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst +0 -0
Documentation/linux_tv/media/dvb/frontend_legacy_api.rst +8 -8
@@ -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
Signature · 1 line
2.7.4
PATCH 4/54 doc-rst: linux_tv: dvb: put return value at the end
In reply to Mauro Carvalho ChehabOn some syscall descriptions, the tables are described after the return value. Do that inside descriptions.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- .../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(-)
Documentation/linux_tv/media/dvb/audio-set-attributes.rst +0 -2
@@ -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
Documentation/linux_tv/media/dvb/audio-set-ext-id.rst +0 -2
@@ -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
Documentation/linux_tv/media/dvb/audio-set-karaoke.rst +0 -2
@@ -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
Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst +10 -9
@@ -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.
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst +7 -10
@@ -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.
Documentation/linux_tv/media/dvb/fe-get-info.rst +10 -9
@@ -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.
Documentation/linux_tv/media/dvb/fe-read-ber.rst +0 -2
@@ -20,8 +20,6 @@ SYNOPSIS Arguments ---------- - - .. flat-table:: :header-rows: 0 :stub-columns: 0
Documentation/linux_tv/media/dvb/fe-read-status.rst +7 -8
@@ -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.
Documentation/linux_tv/media/dvb/fe-set-frontend.rst +0 -2
@@ -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
Documentation/linux_tv/media/dvb/fe-set-tone.rst +7 -10
@@ -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.
Documentation/linux_tv/media/dvb/video-get-event.rst +0 -2
@@ -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
Signature · 1 line
2.7.4
PATCH 5/54 doc-rst: boilerplate HTML theme customization
In reply to Mauro Carvalho ChehabFrom: Markus Heiser <[email protected]>
Implements the minimal boilerplate for Sphinx HTML theme customization.
Signed-off-by Markus Heiser <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- 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
Documentation/conf.py +8 -1
@@ -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
Documentation/sphinx-static/theme_overrides.css new file +9 -0
@@ -0,0 +1,9 @@ +/* -*- coding: utf-8; mode: css -*- + * + * Sphinx HTML theme customization + * + */ + +@media screen { + +}
Signature · 1 line
2.7.4
PATCH 6/54 doc-rst: remove Documentation/linux_tv/conf.py file
In reply to Mauro Carvalho ChehabThis file is actually not used to build the media uAPI docbook. So, remove it.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/conf.py | 221 ----------------------------------------- 1 file changed, 221 deletions(-) delete mode 100644 Documentation/linux_tv/conf.py
Documentation/linux_tv/conf.py deleted +0 -221
@@ -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 -
Signature · 1 line
2.7.4
PATCH 7/54 doc-rst: customize RTD theme, table & full width
In reply to Mauro Carvalho ChehabFrom: Markus Heiser <[email protected]>
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 <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/sphinx-static/theme_overrides.css | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-)
Documentation/sphinx-static/theme_overrides.css +20 -1
@@ -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%; } + }
Signature · 1 line
2.7.4
PATCH 8/54 doc-rst: customize RTD theme, captions & inline literal
In reply to Mauro Carvalho ChehabFrom: Markus Heiser <[email protected]>
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 <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/sphinx-static/theme_overrides.css | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+)
Documentation/sphinx-static/theme_overrides.css +25 -0
@@ -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; + } + }
Signature · 1 line
2.7.4
PATCH 9/54 doc-rst: linux_tv: don't use uppercases for syscall sections
In reply to Mauro Carvalho ChehabOn 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 <[email protected]>
--- .../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(-)
Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-channel-select.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-clear-buffer.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-continue.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-fclose.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/audio-fopen.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/audio-fwrite.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/audio-get-capabilities.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-get-pts.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-get-status.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-pause.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-play.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-select-source.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-attributes.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-av-sync.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-ext-id.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-id.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-karaoke.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-mixer.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-mute.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-set-streamtype.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/audio-stop.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-fclose.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/ca-fopen.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/ca-get-cap.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-get-descr-info.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-get-msg.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-get-slot-info.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-reset.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-send-msg.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-set-descr.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/ca-set-pid.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-add-pid.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-fclose.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/dmx-fopen.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/dmx-fread.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/dmx-fwrite.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/dmx-get-caps.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-get-event.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-get-stc.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-remove-pid.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-filter.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-source.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-start.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/dmx-stop.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-diseqc-recv-slave-reply.rst +7 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-diseqc-reset-overload.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst +7 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-enable-high-lnb-voltage.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-get-event.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-get-frontend.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-get-info.rst +7 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-get-property.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-read-ber.rst +16 -8
@@ -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
Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-read-snr.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-read-status.rst +7 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-set-frontend-tune-mode.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-set-frontend.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-set-tone.rst +7 -5
@@ -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
Documentation/linux_tv/media/dvb/fe-set-voltage.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/frontend_f_close.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/frontend_f_open.rst +6 -5
@@ -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.
Documentation/linux_tv/media/dvb/net-add-if.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/net-get-if.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/net-remove-if.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/video-clear-buffer.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/video-command.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/video-continue.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/video-fast-forward.rst +6 -5
@@ -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
Documentation/linux_tv/media/dvb/video-fclose.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/video-fopen.rst +6 -5
@@ -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::
Documentation/linux_tv/media/dvb/video-freeze.rst +6 -5
@@ -6,18 +6,19 @@ VIDEO_FREEZE ============
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-fwrite.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-capabilities.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-event.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-frame-count.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-frame-rate.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-navi.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-pts.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-size.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-get-status.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-play.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-select-source.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-attributes.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-blank.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-display-format.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-format.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-highlight.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-id.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-spu-palette.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-spu.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-streamtype.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-set-system.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-slowmotion.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-stillpicture.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-stop.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/dvb/video-try-command.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-func-close.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-func-ioctl.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-func-open.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-device-info.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-enum-links.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/mediactl/media-ioc-setup-link.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-close.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-ioctl.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-mmap.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-munmap.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-open.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-poll.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-read.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-select.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/func-write.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-create-bufs.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-cropcap.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dbg-g-chip-info.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dbg-g-register.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-decoder-cmd.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dqevent.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-encoder-cmd.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-dv-timings.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-fmt.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-frameintervals.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-framesizes.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enum-freq-bands.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumaudio.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enuminput.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumoutput.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-enumstd.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-expbuf.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-audio.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-crop.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-ctrl.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-edid.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-enc-index.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-ext-ctrls.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-fbuf.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-fmt.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-frequency.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-input.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-jpegcomp.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-modulator.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-output.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-parm.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-priority.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-selection.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-sliced-vbi-cap.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-std.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-g-tuner.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-log-status.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-overlay.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-prepare-buf.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-qbuf.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-query-dv-timings.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-querybuf.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-querycap.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-queryctrl.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-querystd.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-reqbufs.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-s-hw-freq-seek.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-streamon.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-interval.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-frame-size.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-enum-mbus-code.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-crop.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-fmt.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-frame-interval.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subdev-g-selection.rst +6 -5
Lines of this file are not shown. View the raw message.
Documentation/linux_tv/media/v4l/vidioc-subscribe-event.rst +6 -5
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.7.4
Part of the diff is not shown here. View the raw message.
PATCH 10/54 doc-rst: linux_tv: use :cpp:function:: on all syscalls
In reply to Mauro Carvalho ChehabNow 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 <[email protected]>
--- .../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(-)
Documentation/linux_tv/media/dvb/audio-bilingual-channel-select.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-channel-select.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-clear-buffer.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-continue.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-fclose.rst +1 -1
@@ -15,7 +15,7 @@ DVB audio close() Synopsis -------- -.. c:function:: int close(int fd) +.. cpp:function:: int close(int fd) Arguments
Documentation/linux_tv/media/dvb/audio-fopen.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-fwrite.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-get-capabilities.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-get-pts.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-get-status.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-pause.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-play.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-select-source.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-attributes.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-av-sync.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-bypass-mode.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-ext-id.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-id.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-karaoke.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-mixer.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-mute.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-set-streamtype.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/audio-stop.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-add-pid.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-fclose.rst +1 -1
@@ -15,7 +15,7 @@ DVB demux close() Synopsis -------- -.. c:function:: int close(int fd) +.. cpp:function:: int close(int fd) Arguments
Documentation/linux_tv/media/dvb/dmx-fopen.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-fread.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-fwrite.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-get-caps.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-get-event.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-get-pes-pids.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-get-stc.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-remove-pid.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-buffer-size.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-filter.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-pes-filter.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-set-source.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-start.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/dmx-stop.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-diseqc-send-master-cmd.rst +11 -9
@@ -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. +
Documentation/linux_tv/media/dvb/fe-dishnetwork-send-legacy-cmd.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-get-event.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-get-frontend.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-read-ber.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-read-signal-strength.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-read-snr.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-read-uncorrected-blocks.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-set-frontend.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-set-tone.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/fe-set-voltage.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-clear-buffer.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-command.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-continue.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-fast-forward.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-fclose.rst +1 -1
@@ -15,7 +15,7 @@ dvb video close() Synopsis -------- -.. c:function:: int close(int fd) +.. cpp:function:: int close(int fd) Arguments
Documentation/linux_tv/media/dvb/video-fopen.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-freeze.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-fwrite.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-capabilities.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-event.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-frame-count.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-frame-rate.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-navi.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-pts.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-size.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-get-status.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-play.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-select-source.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-attributes.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-blank.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-display-format.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-format.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-highlight.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-id.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-spu-palette.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-spu.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-streamtype.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-set-system.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-slowmotion.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-stillpicture.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-stop.rst +1 -1
@@ -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
Documentation/linux_tv/media/dvb/video-try-command.rst +1 -1
@@ -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
Documentation/linux_tv/media/v4l/vidioc-g-priority.rst +2 -2
@@ -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
Signature · 1 line
2.7.4
PATCH 11/54 doc-rst: dmabuf: Fix the cross-reference
In reply to Mauro Carvalho ChehabFixes 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 <[email protected]>
--- Documentation/linux_tv/media/v4l/dmabuf.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/linux_tv/media/v4l/dmabuf.rst +1 -1
@@ -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.
Signature · 1 line
2.7.4
PATCH 12/54 doc-rst: dev-overlay: fix the last warning
In reply to Mauro Carvalho ChehabFixes 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 <[email protected]>
--- Documentation/linux_tv/media/v4l/dev-overlay.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/linux_tv/media/v4l/dev-overlay.rst +1 -1
@@ -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
Signature · 1 line
2.7.4
PATCH 13/54 doc-rst: dvbapi: Fix conversion issues
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- Documentation/linux_tv/media/dvb/dvbapi.rst | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-)
Documentation/linux_tv/media/dvb/dvbapi.rst +16 -9
@@ -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: [email protected] +- J. K. Metzler, Ralph <[email protected]> -:author: Metzler Marcus (*O. C.*) -:address: [email protected] + - Original author of the DVB API documentation. -:author: Chehab Mauro (*Carvalho*) -:address: [email protected] -:contrib: Ported document to Docbook XML. +- O. C. Metzler, Marcus <[email protected]> -**Copyright** |copy| 2002, 2003 : Convergence GmbH + - Original author of the DVB API documentation. + +- Carvalho Chehab, Mauro <[email protected]> + + - 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
Signature · 1 line
2.7.4
PATCH 14/54 doc-rst: fix intro_files/dvbstb.png image
In reply to Mauro Carvalho ChehabThe png image was not base64 decoded correctly.
Fix it.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- .../linux_tv/media/dvb/intro_files/dvbstb.png | Bin 22703 -> 22655 bytes 1 file changed, 0 insertions(+), 0 deletions(-)
Documentation/linux_tv/media/dvb/intro_files/dvbstb.png binary +0 -0
Signature · 1 line
2.7.4
PATCH 15/54 doc-rst: dvb/intro: Better show the needed include blocks
In reply to Mauro Carvalho ChehabThe include blocks were not properly displayed. Fix it.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/media/dvb/intro.rst | 18 ------------------ 1 file changed, 18 deletions(-)
Documentation/linux_tv/media/dvb/intro.rst +0 -18
@@ -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
Signature · 1 line
2.7.4
PATCH 16/54 doc-rst: intro: remove obsolete headers
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- Documentation/linux_tv/media/dvb/intro.rst | 5 ----- 1 file changed, 5 deletions(-)
Documentation/linux_tv/media/dvb/intro.rst +0 -5
@@ -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
Signature · 1 line
2.7.4
PATCH 17/54 doc-rst: media-controller: fix conversion issues
In reply to Mauro Carvalho ChehabMake it look just like v4l and DVB parts.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/media/mediactl/media-controller.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-)
Documentation/linux_tv/media/mediactl/media-controller.rst +9 -3
@@ -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: [email protected] -:contrib: Initial version. +- Pinchart, Laurent <[email protected]> + + - Initial version. **Copyright** 2010 : Laurent Pinchart +**************** +Revision History +**************** + :revision: 1.0.0 / 2010-11-10 (*lp*) Initial revision
Signature · 1 line
2.7.4
PATCH 18/54 doc-rst: media-controller: missing credits
In reply to Mauro Carvalho ChehabWhen 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 <[email protected]>
--- Documentation/linux_tv/media/mediactl/media-controller.rst | 7 +++++++ 1 file changed, 7 insertions(+)
Documentation/linux_tv/media/mediactl/media-controller.rst +7 -0
@@ -52,12 +52,19 @@ Authors: - Initial version. +- Carvalho Chehab, Mauro <[email protected]> + + - 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
Signature · 1 line
2.7.4
PATCH 19/54 doc-rst: media-controller.rst: add missing copy symbol
In reply to Mauro Carvalho ChehabJust like V4L and DVB parts, add the copyright symbol.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/media/mediactl/media-controller.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
Documentation/linux_tv/media/mediactl/media-controller.rst +5 -2
@@ -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
Signature · 1 line
2.7.4
PATCH 20/54 doc-rst: media-controller-model: fix a typo
In reply to Mauro Carvalho ChehabRemove a 'm' at the end of the last phrase.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/media/mediactl/media-controller-model.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/linux_tv/media/mediactl/media-controller-model.rst +1 -1
@@ -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.
Signature · 1 line
2.7.4
PATCH 21/54 doc-rst: mediactl: fix some wrong cross references
In reply to Mauro Carvalho ChehabThose cross references should point to media control syscalls, and not to V4L ones.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- 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(-)
Documentation/linux_tv/media/mediactl/media-func-close.rst +1 -1
@@ -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
Documentation/linux_tv/media/mediactl/media-func-ioctl.rst +2 -2
@@ -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
Documentation/linux_tv/media/mediactl/media-func-open.rst +1 -1
@@ -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.
Signature · 1 line
2.7.4
PATCH 22/54 doc-rst: media-ioc-g-topology: Fix tables
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- .../media/mediactl/media-ioc-g-topology.rst | 63 +++------------------- 1 file changed, 6 insertions(+), 57 deletions(-)
Documentation/linux_tv/media/mediactl/media-ioc-g-topology.rst +6 -57
@@ -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.
Signature · 1 line
2.7.4
PATCH 23/54 doc-rst: media-ioc-enum-entities: better format the table
In reply to Mauro Carvalho ChehabAdd a :widths: at the flat-table, to improve the visual.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/linux_tv/media/mediactl/media-ioc-enum-entities.rst +1 -0
@@ -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
Signature · 1 line
2.7.4
PATCH 24/54 doc-rst: gen-errors: Improve table layout
In reply to Mauro Carvalho ChehabAdd a :widths: at the flat-table, to make it to look nicer.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/media/gen-errors.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/linux_tv/media/gen-errors.rst +1 -0
@@ -12,6 +12,7 @@ Generic Error Codes .. flat-table:: Generic error codes :header-rows: 0 :stub-columns: 0 + :widths: 1 16 - .. row 1
Signature · 1 line
2.7.4
PATCH 25/54 doc-rst: remote_controllers: fix conversion issues
In reply to Mauro Carvalho ChehabMake it look like V4L, DVB and MC docbooks initial page.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/media/rc/remote_controllers.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-)
Documentation/linux_tv/media/rc/remote_controllers.rst +12 -4
@@ -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: [email protected] -:contrib: Initial version. +- Carvalho Chehab, Mauro <[email protected]> -**Copyright** 2009-2014 : Mauro Carvalho Chehab + - Initial version. + +**Copyright** |copy| 2009-2016 : Mauro Carvalho Chehab + +**************** +Revision History +**************** :revision: 3.15 / 2014-02-06 (*mcc*)
Signature · 1 line
2.7.4
PATCH 26/54 doc-rst: Rename the title of the Digital TV section
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- Documentation/linux_tv/media/dvb/dvbapi.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
Documentation/linux_tv/media/dvb/dvbapi.rst +6 -3
@@ -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**
Signature · 1 line
2.7.4
PATCH 27/54 doc-rst: v4l2: Rename the V4L2 API title
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- Documentation/linux_tv/media/v4l/v4l2.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
Documentation/linux_tv/media/v4l/v4l2.rst +5 -3
@@ -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**
Signature · 1 line
2.7.4
PATCH 28/54 doc-rst: linux_tv/index: Rename the book name
In reply to Mauro Carvalho ChehabThere'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 <[email protected]>
--- Documentation/linux_tv/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/linux_tv/index.rst +1 -1
@@ -3,7 +3,7 @@ .. include:: <isonum.txt> ############################## -LINUX MEDIA INFRASTRUCTURE API +Linux Media Infrastructure API ############################## **Copyright** |copy| 2009-2016 : LinuxTV Developers
Signature · 1 line
2.7.4
PATCH 29/54 doc-rst: add parse-headers.pl script
In reply to Mauro Carvalho ChehabThis 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 290 ++++++++++++++++++++++++++++++++++ 1 file changed, 290 insertions(+) create mode 100755 Documentation/sphinx/parse-headers.pl
Documentation/sphinx/parse-headers.pl new file +290 -0
@@ -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;
Signature · 1 line
2.7.4
PATCH 30/54 doc-rst: auto-build the frontend.h.rst
In reply to Mauro Carvalho ChehabThis file is auto-generated with DocBook, from the uapi header.
Do the same with Sphinx.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- 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
Documentation/Makefile.sphinx +1 -0
@@ -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:
Documentation/linux_tv/Makefile new file +12 -0
@@ -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
Documentation/linux_tv/frontend.h.rst deleted +0 -609
609 lines not on this page · raw message
Documentation/linux_tv/frontend.h.rst.exceptions new file +47 -0
47 lines not on this page · raw message
Signature · 1 line
2.7.4
PATCH 31/54 doc-rst: parse-headers: improve delimiters to detect symbols
In reply to Mauro Carvalho ChehabAs 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-)
Documentation/sphinx/parse-headers.pl +14 -13
@@ -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; } #
Signature · 1 line
2.7.4
PATCH 32/54 doc-dst: parse-headers: highlight deprecated comments
In reply to Mauro Carvalho ChehabWhen something is deprecated, highlight it, as we want it to be clearer to the reader.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 2 ++ 1 file changed, 2 insertions(+)
Documentation/sphinx/parse-headers.pl +2 -0
@@ -196,6 +196,8 @@ $data =~ s/\n\s+\n/\n\n/g; # $data =~ s,([\_\`\*\<\>\&\\\\:\/]),\\$1,g; +$data =~ s,DEPRECATED,**DEPRECATED**,g; + # # Add references #
Signature · 1 line
2.7.4
PATCH 33/54 doc-rst: fix parsing comments and '{' on a separate line
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-)
Documentation/sphinx/parse-headers.pl +11 -6
@@ -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/;
Signature · 1 line
2.7.4
PATCH 34/54 doc-rst: parse-headers: be more formal about the valid symbols
In reply to Mauro Carvalho ChehabBe more formal about the valid symbols that are expected by the parser, to match what c language expects.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
Documentation/sphinx/parse-headers.pl +8 -8
@@ -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/;
Signature · 1 line
2.7.4
PATCH 35/54 doc-rst: parse-headers: better handle typedefs
In reply to Mauro Carvalho ChehabWhen 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-)
Documentation/sphinx/parse-headers.pl +7 -2
@@ -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/;
Signature · 1 line
2.7.4
PATCH 36/54 doc-rst: parse-headers: fix multiline typedef handler
In reply to Mauro Carvalho ChehabThe 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/sphinx/parse-headers.pl +4 -3
@@ -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/_/-/;
Signature · 1 line
2.7.4
PATCH 37/54 doc-rst: auto-generate dmx.h.rst
In reply to Mauro Carvalho ChehabThis file should be auto-generated from the header files, and not hardcoded.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- 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
Documentation/linux_tv/Makefile +4 -1
@@ -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
Documentation/linux_tv/dmx.h.rst deleted +0 -162
162 lines not on this page · raw message
Documentation/linux_tv/dmx.h.rst.exceptions new file +63 -0
63 lines not on this page · raw message
Signature · 1 line
2.7.4
PATCH 38/54 doc-rst: auto-generate audio.h.rst
In reply to Mauro Carvalho ChehabThis 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 <[email protected]>
--- 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
Documentation/linux_tv/Makefile +6 -3
@@ -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
Documentation/linux_tv/audio.h.rst deleted +0 -142
142 lines not on this page · raw message
Documentation/linux_tv/audio.h.rst.exceptions new file +20 -0
@@ -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
Signature · 1 line
2.7.4
PATCH 39/54 doc-rst: auto-generate ca.h.rst
In reply to Mauro Carvalho ChehabThis 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 <[email protected]>
--- 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
Documentation/linux_tv/Makefile +4 -1
@@ -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
Documentation/linux_tv/ca.h.rst deleted +0 -97
97 lines not on this page · raw message
Documentation/linux_tv/ca.h.rst.exceptions new file +24 -0
@@ -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
Signature · 1 line
2.7.4
PATCH 40/54 doc-rst: auto-generate net.h.rst
In reply to Mauro Carvalho ChehabThis 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 <[email protected]>
--- 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
Documentation/linux_tv/Makefile +7 -3
@@ -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}
Documentation/linux_tv/net.h.rst deleted +0 -59
59 lines not on this page · raw message
Documentation/linux_tv/net.h.rst.exceptions new file +11 -0
@@ -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
Signature · 1 line
2.7.4
PATCH 41/54 doc-rst: auto-generate video.h.rst
In reply to Mauro Carvalho ChehabThis 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 <[email protected]>
--- 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
Documentation/linux_tv/Makefile +4 -1
@@ -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}
Documentation/linux_tv/video.h.rst deleted +0 -280
280 lines not on this page · raw message
Documentation/linux_tv/video.h.rst.exceptions new file +40 -0
@@ -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
Signature · 1 line
2.7.4
PATCH 42/54 doc-rst: parse-headers: better handle comments at the source code
In reply to Mauro Carvalho ChehabWe 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-)
Documentation/sphinx/parse-headers.pl +14 -3
@@ -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;
Signature · 1 line
2.7.4
PATCH 43/54 doc-rst: parse-headers: add an option to ignore enum symbols
In reply to Mauro Carvalho ChehabAt 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 4 ++++ 1 file changed, 4 insertions(+)
Documentation/sphinx/parse-headers.pl +4 -0
@@ -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
Signature · 1 line
2.7.4
PATCH 44/54 doc-rst: parse-headers: don't do substituition references
In reply to Mauro Carvalho ChehabAdd 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 <[email protected]>
--- Documentation/sphinx/parse-headers.pl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/sphinx/parse-headers.pl +1 -1
@@ -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;
Signature · 1 line
2.7.4
PATCH 45/54 doc-rst: autogenerate videodev2.h.rst file
In reply to Mauro Carvalho ChehabThis 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 <[email protected]>
--- 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
Documentation/linux_tv/Makefile +5 -1
@@ -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}
Documentation/linux_tv/media/v4l/audio.rst +4 -4
@@ -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
Documentation/linux_tv/media/v4l/hist-v4l2.rst +2 -2
@@ -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
Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst +2 -2
@@ -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>`.
Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst +1 -1
@@ -1,6 +1,6 @@ .. -*- coding: utf-8; mode: rst -*- -.. _VIDIOC_G_AUDIOOUT: +.. _VIDIOC_G_AUDOUT: ************************************** ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT
Documentation/linux_tv/videodev2.h.rst deleted +0 -2300
2,300 lines not on this page · raw message
Documentation/linux_tv/videodev2.h.rst.exceptions new file +591 -0
591 lines not on this page · raw message
Signature · 1 line
2.7.4
PATCH 46/54 doc-rst: fix some badly converted references
In reply to Mauro Carvalho ChehabSeveral 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 <[email protected]>
--- 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(-)
Documentation/linux_tv/media/dvb/dmx_types.rst +4 -4
@@ -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
Documentation/linux_tv/media/dvb/fe-bandwidth-t.rst +7 -7
@@ -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``
Documentation/linux_tv/media/dvb/fe-diseqc-send-burst.rst +2 -2
@@ -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``
Documentation/linux_tv/media/dvb/fe-get-info.rst +31 -31
248 lines not on this page · raw message
Documentation/linux_tv/media/dvb/fe-read-status.rst +7 -7
@@ -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``
Documentation/linux_tv/media/dvb/fe-set-tone.rst +2 -2
@@ -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``
Documentation/linux_tv/media/dvb/fe-type-t.rst +4 -4
@@ -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``
Documentation/linux_tv/media/dvb/fe_property_parameters.rst +103 -103
824 lines not on this page · raw message
Documentation/linux_tv/media/v4l/control.rst +3 -3
@@ -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
Documentation/linux_tv/media/v4l/extended-controls.rst +57 -57
452 lines not on this page · raw message
Documentation/linux_tv/media/v4l/pixfmt-013.rst +13 -13
@@ -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``
Documentation/linux_tv/media/v4l/pixfmt-indexed.rst +1 -1
@@ -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``
Documentation/linux_tv/media/v4l/pixfmt-packed-rgb.rst +21 -21
168 lines not on this page · raw message
Documentation/linux_tv/media/v4l/pixfmt-packed-yuv.rst +4 -4
@@ -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``
Documentation/linux_tv/media/v4l/pixfmt-reserved.rst +33 -33
264 lines not on this page · raw message
Documentation/linux_tv/media/v4l/subdev-formats.rst +87 -87
668 lines not on this page · raw message
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.7.4
Part of the diff is not shown here. View the raw message.
PATCH 47/54 doc-rst: linux_tv: Don't ignore pix formats
In reply to Mauro Carvalho ChehabNow 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 <[email protected]>
--- 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(-)
Documentation/linux_tv/media/v4l/pixfmt-nv12.rst +1 -0
@@ -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')
Documentation/linux_tv/media/v4l/pixfmt-nv12m.rst +2 -0
@@ -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
Documentation/linux_tv/media/v4l/pixfmt-nv16.rst +1 -0
@@ -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')
Documentation/linux_tv/media/v4l/pixfmt-nv16m.rst +1 -0
@@ -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')
Documentation/linux_tv/media/v4l/pixfmt-nv24.rst +1 -0
@@ -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')
Documentation/linux_tv/media/v4l/pixfmt-sdr-cs08.rst +1 -1
@@ -1,6 +1,6 @@ .. -*- coding: utf-8; mode: rst -*- -.. _V4L2-SDR-FMT-CS08: +.. _v4l2-sdr-fmt-cs8: ************************* V4L2_SDR_FMT_CS8 ('CS08')
Documentation/linux_tv/media/v4l/pixfmt-sdr-cu08.rst +1 -1
@@ -1,6 +1,6 @@ .. -*- coding: utf-8; mode: rst -*- -.. _V4L2-SDR-FMT-CU08: +.. _v4l2-sdr-fmt-cu8: ************************* V4L2_SDR_FMT_CU8 ('CU08')
Documentation/linux_tv/media/v4l/pixfmt-srggb10.rst +3 -0
@@ -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'),
Documentation/linux_tv/media/v4l/pixfmt-srggb10alaw8.rst +3 -0
@@ -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'),
Documentation/linux_tv/media/v4l/pixfmt-srggb10dpcm8.rst +4 -0
@@ -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'),
Documentation/linux_tv/media/v4l/pixfmt-srggb10p.rst +3 -0
@@ -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'),
Documentation/linux_tv/media/v4l/pixfmt-srggb12.rst +4 -0
@@ -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'),
Documentation/linux_tv/media/v4l/pixfmt-yuv410.rst +1 -0
@@ -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')
Documentation/linux_tv/media/v4l/pixfmt-yuv420m.rst +1 -0
@@ -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')
Documentation/linux_tv/media/v4l/pixfmt-yuv422m.rst +1 -0
@@ -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')
Documentation/linux_tv/media/v4l/pixfmt-yuv444m.rst +1 -0
@@ -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')
Documentation/linux_tv/videodev2.h.rst.exceptions +0 -142
148 lines not on this page · raw message
Signature · 1 line
2.7.4
PATCH 48/54 doc-rst: videodev2.h: don't ignore V4L2_STD macros
In reply to Mauro Carvalho ChehabThe content of those macros are all declared at the v4l2-std-id table. So, point to it.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/linux_tv/videodev2.h.rst.exceptions | 94 ++++++++++++----------- 1 file changed, 48 insertions(+), 46 deletions(-)
Documentation/linux_tv/videodev2.h.rst.exceptions +48 -46
@@ -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
Signature · 1 line
2.7.4
PATCH 49/54 doc-rst: document enum symbols
In reply to Mauro Carvalho ChehabAfter 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 <[email protected]>
--- Documentation/linux_tv/videodev2.h.rst.exceptions | 206 ++++++++++++---------- 1 file changed, 116 insertions(+), 90 deletions(-)
Documentation/linux_tv/videodev2.h.rst.exceptions +116 -90
@@ -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
Signature · 1 line
2.7.4
PATCH 50/54 doc-rst: videodev2.h: add cross-references for defines
In reply to Mauro Carvalho ChehabRemove most of ignore stuff for defines, pointing them to the proper tables/sections.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- .../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(-)
Documentation/linux_tv/media/v4l/vidioc-dv-timings-cap.rst +4 -4
@@ -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.
Documentation/linux_tv/media/v4l/vidioc-g-dv-timings.rst +13 -13
@@ -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
Documentation/linux_tv/videodev2.h.rst.exceptions +350 -268
639 lines not on this page · raw message
Signature · 1 line
2.7.4
PATCH 51/54 doc-rst: linux_tv/Makefile: Honor quiet mode
In reply to Mauro Carvalho ChehabCleanup 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 <[email protected]>
--- Documentation/Makefile.sphinx | 2 +- Documentation/linux_tv/Makefile | 49 +++++++++++++++++++++++++++-------------- 2 files changed, 33 insertions(+), 18 deletions(-)
Documentation/Makefile.sphinx +1 -1
@@ -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:
Documentation/linux_tv/Makefile +32 -17
64 lines not on this page · raw message
Signature · 1 line
2.7.4
PATCH 52/54 doc-rst: auto-generate: fixed include "output/*.h.rst" content
In reply to Mauro Carvalho ChehabFrom: Markus Heiser <[email protected]>
Include auto-generate reST header files. BTW fixed linux_tv/Makefile.
Signed-off-by Markus Heiser <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- 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(-)
Documentation/linux_tv/Makefile +5 -2
@@ -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:
Documentation/linux_tv/media/dvb/audio_h.rst +1 -5
@@ -6,8 +6,4 @@ DVB Audio Header File ********************* - -.. toctree:: - :maxdepth: 1 - - ../../audio.h +.. include:: ../../../output/audio.h.rst
Documentation/linux_tv/media/dvb/ca_h.rst +1 -5
@@ -6,8 +6,4 @@ DVB Conditional Access Header File ********************************** - -.. toctree:: - :maxdepth: 1 - - ../../ca.h +.. include:: ../../../output/ca.h.rst
Documentation/linux_tv/media/dvb/dmx_h.rst +1 -5
@@ -6,8 +6,4 @@ DVB Demux Header File ********************* - -.. toctree:: - :maxdepth: 1 - - ../../dmx.h +.. include:: ../../../output/dmx.h.rst
Documentation/linux_tv/media/dvb/frontend_h.rst +1 -5
@@ -6,8 +6,4 @@ DVB Frontend Header File ************************ - -.. toctree:: - :maxdepth: 1 - - ../../frontend.h +.. include:: ../../../output/frontend.h.rst
Documentation/linux_tv/media/dvb/net_h.rst +1 -5
@@ -6,8 +6,4 @@ DVB Network Header File *********************** - -.. toctree:: - :maxdepth: 1 - - ../../net.h +.. include:: ../../../output/net.h.rst
Documentation/linux_tv/media/dvb/video_h.rst +1 -5
@@ -6,8 +6,4 @@ DVB Video Header File ********************* - -.. toctree:: - :maxdepth: 1 - - ../../video.h +.. include:: ../../../output/video.h.rst
Documentation/linux_tv/media/v4l/videodev.rst +1 -5
@@ -6,8 +6,4 @@ Video For Linux Two Header File ******************************* - -.. toctree:: - :maxdepth: 1 - - ../../videodev2.h +.. include:: ../../../output/videodev2.h.rst
Signature · 1 line
2.7.4
PATCH 53/54 doc-rst: add kernel-include directive
In reply to Mauro Carvalho ChehabFrom: Markus Heiser <[email protected]>
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 <[email protected]>
Signed-off-by Mauro Carvalho Chehab <[email protected]>
--- Documentation/sphinx/kernel_include.py | 183 +++++++++++++++++++++++++++++++++ 1 file changed, 183 insertions(+) create mode 100755 Documentation/sphinx/kernel_include.py
Documentation/sphinx/kernel_include.py new file +183 -0
@@ -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 []
Signature · 1 line
2.7.4