From 54f38fcae536ea202ce7d6a359521492fba30c1f Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Wed, 4 Mar 2020 10:21:39 +0100 Subject: [PATCH] media: docs: move uAPI book to userspace-api/media Since 2017, there is an space reserved for userspace API, created by changeset 1d596dee3862 ("docs: Create a user-space API guide"). As the media subsystem was one of the first subsystems to use Sphinx, until this patch, we were keeping things on a separate place. Let's just use the new location, as having all uAPI altogether will likely make things easier for developers. Signed-off-by: Mauro Carvalho Chehab --- .../ABI/testing/debugfs-cec-error-inj | 2 +- Documentation/Makefile | 10 +- Documentation/doc-guide/parse-headers.rst | 2 +- Documentation/fb/api.rst | 4 +- Documentation/media/index.rst | 2 +- .../dvb/audio-bilingual-channel-select.rst | 66 - .../uapi/rc/lirc-set-rec-timeout-reports.rst | 56 - .../media/uapi/v4l/pixfmt-yuv420.rst | 150 - .../it_IT/doc-guide/parse-headers.rst | 2 +- .../{ => userspace-api}/media/Makefile | 2 +- .../media/audio.h.rst.exceptions | 0 .../media/ca.h.rst.exceptions | 0 .../media/cec.h.rst.exceptions | 0 .../media/cec/cec-api.rst} | 38 +- .../media/cec/cec-func-close.rst} | 24 +- .../media/cec/cec-func-ioctl.rst} | 44 +- .../media}/cec/cec-func-open.rst | 2 +- .../media}/cec/cec-func-poll.rst | 2 +- .../media/cec/cec-funcs.rst} | 22 +- .../media/cec/cec-header.rst} | 19 +- .../media}/cec/cec-intro.rst | 2 +- .../media}/cec/cec-ioc-adap-g-caps.rst | 2 +- .../media}/cec/cec-ioc-adap-g-conn-info.rst | 0 .../media}/cec/cec-ioc-adap-g-log-addrs.rst | 2 +- .../media}/cec/cec-ioc-adap-g-phys-addr.rst | 2 +- .../media}/cec/cec-ioc-dqevent.rst | 2 +- .../media}/cec/cec-ioc-g-mode.rst | 2 +- .../media}/cec/cec-ioc-receive.rst | 2 +- .../media}/cec/cec-pin-error-inj.rst | 2 +- .../{ => userspace-api}/media/conf_nitpick.py | 0 .../media/dmx.h.rst.exceptions | 0 .../dvb/audio-bilingual-channel-select.rst} | 42 +- .../media/dvb/audio-channel-select.rst} | 32 +- .../media/dvb/audio-clear-buffer.rst} | 34 +- .../media/dvb/audio-continue.rst} | 21 +- .../media/dvb/audio-fclose.rst} | 40 +- .../media/dvb/audio-fopen.rst} | 53 +- .../media}/dvb/audio-fwrite.rst | 2 +- .../media/dvb/audio-get-capabilities.rst} | 29 +- .../media/dvb/audio-get-status.rst} | 40 +- .../media/dvb/audio-pause.rst} | 37 +- .../media/dvb/audio-play.rst} | 23 +- .../media/dvb/audio-select-source.rst} | 26 +- .../media/dvb/audio-set-av-sync.rst} | 28 +- .../media/dvb/audio-set-bypass-mode.rst} | 38 +- .../media}/dvb/audio-set-id.rst | 2 +- .../media/dvb/audio-set-mixer.rst} | 37 +- .../media/dvb/audio-set-mute.rst} | 50 +- .../media}/dvb/audio-set-streamtype.rst | 2 +- .../media/dvb/audio-stop.rst} | 34 +- .../media}/dvb/audio.rst | 2 +- .../media}/dvb/audio_data_types.rst | 2 +- .../media}/dvb/audio_function_calls.rst | 2 +- .../media/dvb/ca-fclose.rst} | 24 +- .../media}/dvb/ca-fopen.rst | 2 +- .../media/dvb/ca-get-cap.rst} | 32 +- .../media/dvb/ca-get-descr-info.rst} | 32 +- .../media/dvb/ca-get-msg.rst} | 45 +- .../media/dvb/ca-get-slot-info.rst} | 47 +- .../media/dvb/ca-reset.rst} | 27 +- .../media/dvb/ca-send-msg.rst} | 35 +- .../media/dvb/ca-set-descr.rst} | 39 +- .../uapi => userspace-api/media}/dvb/ca.rst | 2 +- .../media/dvb/ca_data_types.rst} | 16 +- .../media/dvb/ca_function_calls.rst} | 22 +- .../media}/dvb/ca_high_level.rst | 0 .../media}/dvb/demux.rst | 2 +- .../media/dvb/dmx-add-pid.rst} | 29 +- .../media}/dvb/dmx-expbuf.rst | 2 +- .../media/dvb/dmx-fclose.rst} | 29 +- .../media}/dvb/dmx-fopen.rst | 2 +- .../media}/dvb/dmx-fread.rst | 2 +- .../media}/dvb/dmx-fwrite.rst | 2 +- .../media}/dvb/dmx-get-pes-pids.rst | 2 +- .../media}/dvb/dmx-get-stc.rst | 2 +- .../media}/dvb/dmx-mmap.rst | 2 +- .../media}/dvb/dmx-munmap.rst | 2 +- .../media}/dvb/dmx-qbuf.rst | 2 +- .../media}/dvb/dmx-querybuf.rst | 2 +- .../media}/dvb/dmx-remove-pid.rst | 2 +- .../media}/dvb/dmx-reqbufs.rst | 2 +- .../media/dvb/dmx-set-buffer-size.rst} | 35 +- .../media}/dvb/dmx-set-filter.rst | 2 +- .../media/dvb/dmx-set-pes-filter.rst} | 35 +- .../media/dvb/dmx-start.rst} | 35 +- .../media/dvb/dmx-stop.rst} | 41 +- .../media}/dvb/dmx_fcalls.rst | 2 +- .../media/dvb/dmx_types.rst} | 11 +- .../media}/dvb/dvb-fe-read-status.rst | 2 +- .../media/dvb/dvb-frontend-event.rst} | 18 +- .../media}/dvb/dvb-frontend-parameters.rst | 2 +- .../media}/dvb/dvbapi.rst | 2 +- .../media}/dvb/dvbproperty.rst | 2 +- .../media}/dvb/dvbstb.svg | 2 +- .../media}/dvb/examples.rst | 2 +- .../media}/dvb/fe-bandwidth-t.rst | 2 +- .../media/dvb/fe-diseqc-recv-slave-reply.rst} | 40 +- .../media/dvb/fe-diseqc-reset-overload.rst} | 26 +- .../media}/dvb/fe-diseqc-send-burst.rst | 2 +- .../media/dvb/fe-diseqc-send-master-cmd.rst} | 40 +- .../dvb/fe-dishnetwork-send-legacy-cmd.rst} | 31 +- .../media}/dvb/fe-enable-high-lnb-voltage.rst | 2 +- .../media}/dvb/fe-get-event.rst | 2 +- .../media/dvb/fe-get-frontend.rst} | 45 +- .../media}/dvb/fe-get-info.rst | 2 +- .../media}/dvb/fe-get-property.rst | 2 +- .../media/dvb/fe-read-ber.rst} | 44 +- .../media/dvb/fe-read-signal-strength.rst} | 26 +- .../media/dvb/fe-read-snr.rst} | 37 +- .../media}/dvb/fe-read-status.rst | 2 +- .../media}/dvb/fe-read-uncorrected-blocks.rst | 2 +- .../media}/dvb/fe-set-frontend-tune-mode.rst | 2 +- .../media}/dvb/fe-set-frontend.rst | 2 +- .../media}/dvb/fe-set-tone.rst | 2 +- .../media}/dvb/fe-set-voltage.rst | 2 +- .../media}/dvb/fe-type-t.rst | 2 +- .../media}/dvb/fe_property_parameters.rst | 2 +- .../media/dvb/frontend-header.rst} | 24 +- .../dvb/frontend-property-cable-systems.rst | 2 +- .../frontend-property-satellite-systems.rst | 2 +- .../frontend-property-terrestrial-systems.rst | 2 +- .../media}/dvb/frontend-stat-properties.rst | 2 +- .../media}/dvb/frontend.rst | 2 +- .../media/dvb/frontend_f_close.rst} | 30 +- .../media}/dvb/frontend_f_open.rst | 2 +- .../media}/dvb/frontend_fcalls.rst | 2 +- .../media}/dvb/frontend_legacy_api.rst | 2 +- .../media}/dvb/frontend_legacy_dvbv3_api.rst | 2 +- .../media}/dvb/headers.rst | 2 +- .../media}/dvb/intro.rst | 2 +- .../media}/dvb/legacy_dvb_apis.rst | 2 +- .../userspace-api/media/dvb/net-add-if.rst | 60 + .../media/dvb/net-get-if.rst} | 25 +- .../media/dvb/net-remove-if.rst} | 26 +- .../media/dvb/net-types.rst} | 18 +- .../uapi => userspace-api/media}/dvb/net.rst | 2 +- .../media}/dvb/query-dvb-frontend-info.rst | 2 +- .../media/dvb/video-clear-buffer.rst} | 32 +- .../userspace-api/media/dvb/video-command.rst | 105 + .../media/dvb/video-continue.rst} | 34 +- .../media/dvb/video-fast-forward.rst} | 46 +- .../media/dvb/video-fclose.rst} | 40 +- .../media/dvb/video-fopen.rst} | 53 +- .../media/dvb/video-freeze.rst} | 56 +- .../media/dvb/video-fwrite.rst} | 49 +- .../media/dvb/video-get-capabilities.rst} | 40 +- .../media}/dvb/video-get-event.rst | 2 +- .../media/dvb/video-get-frame-count.rst} | 33 +- .../media/dvb/video-get-pts.rst} | 35 +- .../media/dvb/video-get-size.rst} | 43 +- .../media/dvb/video-get-status.rst} | 40 +- .../media/dvb/video-play.rst} | 45 +- .../media}/dvb/video-select-source.rst | 2 +- .../media/dvb/video-set-blank.rst} | 41 +- .../media/dvb/video-set-display-format.rst} | 41 +- .../media/dvb/video-set-format.rst} | 52 +- .../media/dvb/video-set-streamtype.rst} | 36 +- .../media/dvb/video-slowmotion.rst} | 50 +- .../media/dvb/video-stillpicture.rst} | 36 +- .../media/dvb/video-stop.rst} | 45 +- .../media/dvb/video-try-command.rst} | 58 +- .../media}/dvb/video.rst | 2 +- .../media}/dvb/video_function_calls.rst | 2 +- .../media}/dvb/video_types.rst | 2 +- .../media}/fdl-appendix.rst | 2 +- .../media/frontend.h.rst.exceptions | 0 .../media}/gen-errors.rst | 2 +- .../media/index.rst} | 14 +- .../{ => userspace-api}/media/intro.rst | 0 .../media/lirc.h.rst.exceptions | 0 .../media/media.h.rst.exceptions | 0 .../mediactl/media-controller-intro.rst | 2 +- .../mediactl/media-controller-model.rst | 2 +- .../media/mediactl/media-controller.rst} | 38 +- .../media/mediactl/media-func-close.rst} | 24 +- .../media/mediactl/media-func-ioctl.rst} | 33 +- .../media}/mediactl/media-func-open.rst | 2 +- .../media}/mediactl/media-funcs.rst | 2 +- .../media/mediactl/media-header.rst} | 22 +- .../media}/mediactl/media-ioc-device-info.rst | 2 +- .../mediactl/media-ioc-enum-entities.rst | 2 +- .../media}/mediactl/media-ioc-enum-links.rst | 2 +- .../media}/mediactl/media-ioc-g-topology.rst | 2 +- .../mediactl/media-ioc-request-alloc.rst | 2 +- .../media}/mediactl/media-ioc-setup-link.rst | 2 +- .../mediactl/media-request-ioc-queue.rst | 2 +- .../mediactl/media-request-ioc-reinit.rst} | 60 +- .../media}/mediactl/media-types.rst | 2 +- .../media}/mediactl/request-api.rst | 2 +- .../media/mediactl/request-func-close.rst} | 61 +- .../media/mediactl/request-func-ioctl.rst} | 60 +- .../media}/mediactl/request-func-poll.rst | 2 +- .../media/net.h.rst.exceptions | 0 .../media}/rc/keytable.c.rst | 2 +- .../media}/rc/lirc-dev-intro.rst | 2 +- .../media/rc/lirc-dev.rst} | 16 +- .../media}/rc/lirc-func.rst | 2 +- .../media}/rc/lirc-get-features.rst | 2 +- .../media}/rc/lirc-get-rec-mode.rst | 2 +- .../media}/rc/lirc-get-rec-resolution.rst | 2 +- .../media}/rc/lirc-get-send-mode.rst | 2 +- .../media}/rc/lirc-get-timeout.rst | 2 +- .../media/rc/lirc-header.rst} | 25 +- .../media}/rc/lirc-read.rst | 2 +- .../rc/lirc-set-measure-carrier-mode.rst | 2 +- .../media}/rc/lirc-set-rec-carrier-range.rst | 2 +- .../media/rc/lirc-set-rec-carrier.rst} | 25 +- .../rc/lirc-set-rec-timeout-reports.rst} | 31 +- .../media}/rc/lirc-set-rec-timeout.rst | 2 +- .../media/rc/lirc-set-send-carrier.rst} | 33 +- .../media}/rc/lirc-set-send-duty-cycle.rst | 2 +- .../media}/rc/lirc-set-transmitter-mask.rst | 2 +- .../media}/rc/lirc-set-wideband-receiver.rst | 2 +- .../media}/rc/lirc-write.rst | 2 +- .../media}/rc/rc-intro.rst | 2 +- .../media}/rc/rc-protos.rst | 0 .../media}/rc/rc-sysfs-nodes.rst | 2 +- .../media/rc/rc-table-change.rst} | 21 +- .../media}/rc/rc-tables.rst | 2 +- .../media}/rc/remote_controllers.rst | 2 +- .../media/typical_media_device.svg | 2 +- .../media}/v4l/app-pri.rst | 2 +- .../media/v4l/async.rst} | 12 +- .../media}/v4l/audio.rst | 2 +- .../media}/v4l/bayer.svg | 2 +- .../media}/v4l/biblio.rst | 2 +- .../media}/v4l/buffer.rst | 2 +- .../media/v4l/capture-example.rst} | 13 +- .../media}/v4l/capture.c.rst | 2 +- .../media}/v4l/colorspaces-defs.rst | 2 +- .../media}/v4l/colorspaces-details.rst | 2 +- .../media}/v4l/colorspaces.rst | 2 +- .../media/v4l/common-defs.rst} | 16 +- .../media}/v4l/common.rst | 2 +- .../media/v4l/compat.rst} | 30 +- .../media}/v4l/constraints.svg | 2 +- .../media}/v4l/control.rst | 2 +- .../uapi => userspace-api/media}/v4l/crop.rst | 2 +- .../uapi => userspace-api/media}/v4l/crop.svg | 2 +- .../media/v4l/depth-formats.rst} | 25 +- .../media}/v4l/dev-capture.rst | 2 +- .../media}/v4l/dev-decoder.rst | 0 .../media}/v4l/dev-event.rst | 2 +- .../media}/v4l/dev-mem2mem.rst | 2 +- .../media}/v4l/dev-meta.rst | 2 +- .../media}/v4l/dev-osd.rst | 2 +- .../media}/v4l/dev-output.rst | 2 +- .../media}/v4l/dev-overlay.rst | 2 +- .../media}/v4l/dev-radio.rst | 2 +- .../media}/v4l/dev-raw-vbi.rst | 2 +- .../media}/v4l/dev-rds.rst | 2 +- .../media}/v4l/dev-sdr.rst | 2 +- .../media}/v4l/dev-sliced-vbi.rst | 2 +- .../media}/v4l/dev-stateless-decoder.rst | 0 .../media}/v4l/dev-subdev.rst | 2 +- .../media}/v4l/dev-touch.rst | 2 +- .../media/v4l/devices.rst} | 30 +- .../media}/v4l/diff-v4l.rst | 2 +- .../media}/v4l/dmabuf.rst | 2 +- .../media}/v4l/dv-timings.rst | 2 +- .../media}/v4l/ext-ctrls-camera.rst | 2 +- .../media}/v4l/ext-ctrls-codec.rst | 2 +- .../media}/v4l/ext-ctrls-detect.rst | 2 +- .../media}/v4l/ext-ctrls-dv.rst | 2 +- .../media}/v4l/ext-ctrls-flash.rst | 2 +- .../media}/v4l/ext-ctrls-fm-rx.rst | 2 +- .../media}/v4l/ext-ctrls-fm-tx.rst | 2 +- .../media}/v4l/ext-ctrls-image-process.rst | 2 +- .../media}/v4l/ext-ctrls-image-source.rst | 2 +- .../media}/v4l/ext-ctrls-jpeg.rst | 2 +- .../media}/v4l/ext-ctrls-rf-tuner.rst | 2 +- .../media}/v4l/extended-controls.rst | 2 +- .../media}/v4l/field-order.rst | 2 +- .../media/v4l/fieldseq_bt.svg} | 3075 +++++++++-------- .../media/v4l/fieldseq_tb.svg} | 3075 ++++++++--------- .../media}/v4l/format.rst | 2 +- .../media}/v4l/func-close.rst | 2 +- .../media/v4l/func-ioctl.rst} | 43 +- .../media}/v4l/func-mmap.rst | 2 +- .../media}/v4l/func-munmap.rst | 2 +- .../media}/v4l/func-open.rst | 2 +- .../media}/v4l/func-poll.rst | 2 +- .../media}/v4l/func-read.rst | 2 +- .../media}/v4l/func-select.rst | 2 +- .../media}/v4l/func-write.rst | 2 +- .../media}/v4l/hist-v4l2.rst | 2 +- .../media/v4l/hsv-formats.rst} | 21 +- .../uapi => userspace-api/media}/v4l/io.rst | 2 +- .../media}/v4l/libv4l-introduction.rst | 2 +- .../media/v4l/libv4l.rst} | 15 +- .../media}/v4l/meta-formats.rst | 2 +- .../uapi => userspace-api/media}/v4l/mmap.rst | 2 +- .../media}/v4l/nv12mt.svg | 2 +- .../media}/v4l/nv12mt_example.svg | 2 +- .../uapi => userspace-api/media}/v4l/open.rst | 2 +- .../media}/v4l/pipeline.dot | 0 .../media}/v4l/pixfmt-bayer.rst | 2 +- .../media}/v4l/pixfmt-cnf4.rst | 0 .../media}/v4l/pixfmt-compressed.rst | 2 +- .../media}/v4l/pixfmt-grey.rst | 2 +- .../media}/v4l/pixfmt-indexed.rst | 2 +- .../media}/v4l/pixfmt-intro.rst | 2 +- .../media}/v4l/pixfmt-inzi.rst | 2 +- .../media/v4l/pixfmt-m420.rst} | 92 +- .../media}/v4l/pixfmt-meta-d4xx.rst | 2 +- .../media}/v4l/pixfmt-meta-intel-ipu3.rst | 2 +- .../media}/v4l/pixfmt-meta-uvc.rst | 2 +- .../media/v4l/pixfmt-meta-vivid.rst} | 61 +- .../media}/v4l/pixfmt-meta-vsp1-hgo.rst | 2 +- .../media}/v4l/pixfmt-meta-vsp1-hgt.rst | 2 +- .../media/v4l/pixfmt-nv12.rst} | 58 +- .../media}/v4l/pixfmt-nv12m.rst | 2 +- .../media}/v4l/pixfmt-nv12mt.rst | 2 +- .../media/v4l/pixfmt-nv16.rst} | 76 +- .../userspace-api/media/v4l/pixfmt-nv16m.rst | 164 + .../media}/v4l/pixfmt-nv24.rst | 2 +- .../media}/v4l/pixfmt-packed-hsv.rst | 2 +- .../media}/v4l/pixfmt-packed-yuv.rst | 2 +- .../media}/v4l/pixfmt-reserved.rst | 2 +- .../media}/v4l/pixfmt-rgb.rst | 2 +- .../media/v4l/pixfmt-sdr-cs08.rst} | 28 +- .../media}/v4l/pixfmt-sdr-cs14le.rst | 2 +- .../media/v4l/pixfmt-sdr-cu08.rst} | 26 +- .../media/v4l/pixfmt-sdr-cu16le.rst} | 26 +- .../media/v4l/pixfmt-sdr-pcu16be.rst} | 36 +- .../media}/v4l/pixfmt-sdr-pcu18be.rst | 2 +- .../media/v4l/pixfmt-sdr-pcu20be.rst} | 36 +- .../media/v4l/pixfmt-sdr-ru12le.rst} | 28 +- .../media}/v4l/pixfmt-srggb10-ipu3.rst | 2 +- .../media/v4l/pixfmt-srggb10.rst} | 39 +- .../media/v4l/pixfmt-srggb10alaw8.rst} | 28 +- .../media/v4l/pixfmt-srggb10dpcm8.rst} | 28 +- .../media}/v4l/pixfmt-srggb10p.rst | 2 +- .../media}/v4l/pixfmt-srggb12.rst | 2 +- .../media}/v4l/pixfmt-srggb12p.rst | 2 +- .../media/v4l/pixfmt-srggb14.rst} | 39 +- .../media}/v4l/pixfmt-srggb14p.rst | 2 +- .../media}/v4l/pixfmt-srggb16.rst | 2 +- .../media}/v4l/pixfmt-srggb8.rst | 2 +- .../media}/v4l/pixfmt-tch-td08.rst | 2 +- .../media}/v4l/pixfmt-tch-td16.rst | 2 +- .../media}/v4l/pixfmt-tch-tu08.rst | 2 +- .../media}/v4l/pixfmt-tch-tu16.rst | 2 +- .../media}/v4l/pixfmt-uv8.rst | 2 +- .../media/v4l/pixfmt-uyvy.rst} | 73 +- .../media}/v4l/pixfmt-v4l2-mplane.rst | 2 +- .../media}/v4l/pixfmt-v4l2.rst | 2 +- .../media/v4l/pixfmt-vyuy.rst} | 42 +- .../media}/v4l/pixfmt-y10.rst | 2 +- .../media}/v4l/pixfmt-y10b.rst | 2 +- .../media}/v4l/pixfmt-y10p.rst | 2 +- .../media/v4l/pixfmt-y12.rst} | 52 +- .../media}/v4l/pixfmt-y12i.rst | 2 +- .../media}/v4l/pixfmt-y14.rst | 2 +- .../media/v4l/pixfmt-y16-be.rst} | 46 +- .../media/v4l/pixfmt-y16.rst} | 14 +- .../media/v4l/pixfmt-y41p.rst} | 87 +- .../media}/v4l/pixfmt-y8i.rst | 2 +- .../media/v4l/pixfmt-yuv410.rst} | 82 +- .../media/v4l/pixfmt-yuv411p.rst} | 82 +- .../media/v4l/pixfmt-yuv420.rst} | 68 +- .../media}/v4l/pixfmt-yuv420m.rst | 2 +- .../media}/v4l/pixfmt-yuv422m.rst | 2 +- .../media}/v4l/pixfmt-yuv422p.rst | 2 +- .../media}/v4l/pixfmt-yuv444m.rst | 2 +- .../media}/v4l/pixfmt-yuyv.rst | 2 +- .../media/v4l/pixfmt-yvyu.rst} | 90 +- .../media}/v4l/pixfmt-z16.rst | 2 +- .../media}/v4l/pixfmt.rst | 2 +- .../media}/v4l/planar-apis.rst | 2 +- .../media}/v4l/querycap.rst | 2 +- .../uapi => userspace-api/media}/v4l/rw.rst | 2 +- .../media/v4l/sdr-formats.rst} | 25 +- .../v4l/selection-api-configuration.rst | 2 +- .../media}/v4l/selection-api-examples.rst | 2 +- .../media}/v4l/selection-api-intro.rst | 2 +- .../media/v4l/selection-api-targets.rst} | 23 +- .../media}/v4l/selection-api-vs-crop-api.rst | 2 +- .../media/v4l/selection-api.rst} | 19 +- .../media}/v4l/selection.svg | 2 +- .../media}/v4l/selections-common.rst | 2 +- .../media}/v4l/standard.rst | 2 +- .../media}/v4l/streaming-par.rst | 2 +- .../media}/v4l/subdev-formats.rst | 2 +- .../v4l/subdev-image-processing-crop.svg | 2 +- .../v4l/subdev-image-processing-full.svg | 2 +- ...-image-processing-scaling-multi-source.svg | 2 +- .../media/v4l/tch-formats.rst} | 21 +- .../media}/v4l/tuner.rst | 2 +- .../media}/v4l/user-func.rst | 2 +- .../media}/v4l/userp.rst | 2 +- .../media}/v4l/v4l2-selection-flags.rst | 2 +- .../media}/v4l/v4l2-selection-targets.rst | 2 +- .../uapi => userspace-api/media}/v4l/v4l2.rst | 2 +- .../media/v4l/v4l2grab-example.rst} | 19 +- .../media}/v4l/v4l2grab.c.rst | 2 +- .../media}/v4l/vbi_525.svg | 2 +- .../media}/v4l/vbi_625.svg | 2 +- .../media}/v4l/vbi_hsync.svg | 2 +- .../media}/v4l/video.rst | 2 +- .../media/v4l/videodev.rst} | 21 +- .../media}/v4l/vidioc-create-bufs.rst | 2 +- .../media}/v4l/vidioc-cropcap.rst | 2 +- .../media}/v4l/vidioc-dbg-g-chip-info.rst | 2 +- .../media}/v4l/vidioc-dbg-g-register.rst | 2 +- .../media}/v4l/vidioc-decoder-cmd.rst | 2 +- .../media}/v4l/vidioc-dqevent.rst | 2 +- .../media}/v4l/vidioc-dv-timings-cap.rst | 2 +- .../media}/v4l/vidioc-encoder-cmd.rst | 2 +- .../media}/v4l/vidioc-enum-dv-timings.rst | 2 +- .../media}/v4l/vidioc-enum-fmt.rst | 2 +- .../media}/v4l/vidioc-enum-frameintervals.rst | 2 +- .../media}/v4l/vidioc-enum-framesizes.rst | 2 +- .../media}/v4l/vidioc-enum-freq-bands.rst | 2 +- .../media}/v4l/vidioc-enumaudio.rst | 2 +- .../media}/v4l/vidioc-enumaudioout.rst | 2 +- .../media}/v4l/vidioc-enuminput.rst | 2 +- .../media}/v4l/vidioc-enumoutput.rst | 2 +- .../media}/v4l/vidioc-enumstd.rst | 2 +- .../media}/v4l/vidioc-expbuf.rst | 2 +- .../media}/v4l/vidioc-g-audio.rst | 2 +- .../media}/v4l/vidioc-g-audioout.rst | 2 +- .../media}/v4l/vidioc-g-crop.rst | 2 +- .../media}/v4l/vidioc-g-ctrl.rst | 2 +- .../media}/v4l/vidioc-g-dv-timings.rst | 2 +- .../media}/v4l/vidioc-g-edid.rst | 2 +- .../media}/v4l/vidioc-g-enc-index.rst | 2 +- .../media}/v4l/vidioc-g-ext-ctrls.rst | 2 +- .../media}/v4l/vidioc-g-fbuf.rst | 2 +- .../media}/v4l/vidioc-g-fmt.rst | 2 +- .../media}/v4l/vidioc-g-frequency.rst | 2 +- .../media}/v4l/vidioc-g-input.rst | 2 +- .../media}/v4l/vidioc-g-jpegcomp.rst | 2 +- .../media}/v4l/vidioc-g-modulator.rst | 2 +- .../media}/v4l/vidioc-g-output.rst | 2 +- .../media}/v4l/vidioc-g-parm.rst | 2 +- .../media}/v4l/vidioc-g-priority.rst | 2 +- .../media}/v4l/vidioc-g-selection.rst | 2 +- .../media}/v4l/vidioc-g-sliced-vbi-cap.rst | 2 +- .../media}/v4l/vidioc-g-std.rst | 2 +- .../media}/v4l/vidioc-g-tuner.rst | 2 +- .../media}/v4l/vidioc-log-status.rst | 2 +- .../media}/v4l/vidioc-overlay.rst | 2 +- .../media}/v4l/vidioc-prepare-buf.rst | 2 +- .../media}/v4l/vidioc-qbuf.rst | 2 +- .../media}/v4l/vidioc-query-dv-timings.rst | 2 +- .../media}/v4l/vidioc-querybuf.rst | 2 +- .../media}/v4l/vidioc-querycap.rst | 2 +- .../media}/v4l/vidioc-queryctrl.rst | 2 +- .../media}/v4l/vidioc-querystd.rst | 2 +- .../media}/v4l/vidioc-reqbufs.rst | 2 +- .../media}/v4l/vidioc-s-hw-freq-seek.rst | 2 +- .../media}/v4l/vidioc-streamon.rst | 2 +- .../v4l/vidioc-subdev-enum-frame-interval.rst | 2 +- .../v4l/vidioc-subdev-enum-frame-size.rst | 2 +- .../v4l/vidioc-subdev-enum-mbus-code.rst | 2 +- .../media}/v4l/vidioc-subdev-g-crop.rst | 2 +- .../media}/v4l/vidioc-subdev-g-fmt.rst | 2 +- .../v4l/vidioc-subdev-g-frame-interval.rst | 2 +- .../media}/v4l/vidioc-subdev-g-selection.rst | 2 +- .../media}/v4l/vidioc-subscribe-event.rst | 2 +- .../media}/v4l/yuv-formats.rst | 2 +- .../media/video.h.rst.exceptions | 0 .../media/videodev2.h.rst.exceptions | 0 MAINTAINERS | 8 +- drivers/media/radio/Kconfig | 10 +- drivers/media/radio/wl128x/Kconfig | 2 +- 467 files changed, 6009 insertions(+), 6007 deletions(-) delete mode 100644 Documentation/media/uapi/dvb/audio-bilingual-channel-select.rst delete mode 100644 Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst delete mode 100644 Documentation/media/uapi/v4l/pixfmt-yuv420.rst rename Documentation/{ => userspace-api}/media/Makefile (97%) rename Documentation/{ => userspace-api}/media/audio.h.rst.exceptions (100%) rename Documentation/{ => userspace-api}/media/ca.h.rst.exceptions (100%) rename Documentation/{ => userspace-api}/media/cec.h.rst.exceptions (100%) rename Documentation/{media/uapi/mediactl/media-controller.rst => userspace-api/media/cec/cec-api.rst} (53%) rename Documentation/{media/uapi/mediactl/media-func-close.rst => userspace-api/media/cec/cec-func-close.rst} (61%) rename Documentation/{media/uapi/v4l/func-ioctl.rst => userspace-api/media/cec/cec-func-ioctl.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-func-open.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-func-poll.rst (97%) rename Documentation/{media/uapi/v4l/libv4l.rst => userspace-api/media/cec/cec-funcs.rst} (53%) rename Documentation/{media/uapi/v4l/depth-formats.rst => userspace-api/media/cec/cec-header.rst} (61%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-intro.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-ioc-adap-g-caps.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-ioc-adap-g-conn-info.rst (100%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-ioc-adap-g-log-addrs.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-ioc-adap-g-phys-addr.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-ioc-dqevent.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-ioc-g-mode.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-ioc-receive.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/cec/cec-pin-error-inj.rst (99%) rename Documentation/{ => userspace-api}/media/conf_nitpick.py (100%) rename Documentation/{ => userspace-api}/media/dmx.h.rst.exceptions (100%) rename Documentation/{media/uapi/dvb/video-get-capabilities.rst => userspace-api/media/dvb/audio-bilingual-channel-select.rst} (50%) rename Documentation/{media/uapi/dvb/video-continue.rst => userspace-api/media/dvb/audio-channel-select.rst} (60%) rename Documentation/{media/uapi/dvb/audio-fclose.rst => userspace-api/media/dvb/audio-clear-buffer.rst} (57%) rename Documentation/{media/uapi/dvb/audio-clear-buffer.rst => userspace-api/media/dvb/audio-continue.rst} (72%) rename Documentation/{media/uapi/dvb/audio-set-mixer.rst => userspace-api/media/dvb/audio-fclose.rst} (55%) rename Documentation/{media/uapi/dvb/video-fopen.rst => userspace-api/media/dvb/audio-fopen.rst} (53%) rename Documentation/{media/uapi => userspace-api/media}/dvb/audio-fwrite.rst (96%) rename Documentation/{media/uapi/dvb/audio-continue.rst => userspace-api/media/dvb/audio-get-capabilities.rst} (63%) rename Documentation/{media/uapi/dvb/video-set-blank.rst => userspace-api/media/dvb/audio-get-status.rst} (59%) rename Documentation/{media/uapi/dvb/video-stillpicture.rst => userspace-api/media/dvb/audio-pause.rst} (54%) rename Documentation/{media/uapi/dvb/audio-pause.rst => userspace-api/media/dvb/audio-play.rst} (69%) rename Documentation/{media/uapi/dvb/audio-get-status.rst => userspace-api/media/dvb/audio-select-source.rst} (58%) rename Documentation/{media/uapi/dvb/audio-get-capabilities.rst => userspace-api/media/dvb/audio-set-av-sync.rst} (64%) rename Documentation/{media/uapi/dvb/audio-play.rst => userspace-api/media/dvb/audio-set-bypass-mode.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/dvb/audio-set-id.rst (96%) rename Documentation/{media/uapi/dvb/video-set-streamtype.rst => userspace-api/media/dvb/audio-set-mixer.rst} (55%) rename Documentation/{media/uapi/dvb/video-stop.rst => userspace-api/media/dvb/audio-set-mute.rst} (54%) rename Documentation/{media/uapi => userspace-api/media}/dvb/audio-set-streamtype.rst (96%) rename Documentation/{media/uapi/dvb/video-fclose.rst => userspace-api/media/dvb/audio-stop.rst} (58%) rename Documentation/{media/uapi => userspace-api/media}/dvb/audio.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/dvb/audio_data_types.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/dvb/audio_function_calls.rst (94%) rename Documentation/{media/uapi/dvb/dmx-stop.rst => userspace-api/media/dvb/ca-fclose.rst} (59%) rename Documentation/{media/uapi => userspace-api/media}/dvb/ca-fopen.rst (97%) rename Documentation/{media/uapi/dvb/ca-get-descr-info.rst => userspace-api/media/dvb/ca-get-cap.rst} (54%) rename Documentation/{media/uapi/dvb/ca-reset.rst => userspace-api/media/dvb/ca-get-descr-info.rst} (52%) rename Documentation/{media/uapi/dvb/fe-diseqc-send-master-cmd.rst => userspace-api/media/dvb/ca-get-msg.rst} (50%) rename Documentation/{media/uapi/dvb/net-remove-if.rst => userspace-api/media/dvb/ca-get-slot-info.rst} (50%) rename Documentation/{media/uapi/dvb/dmx-fclose.rst => userspace-api/media/dvb/ca-reset.rst} (53%) rename Documentation/{media/uapi/dvb/dmx-set-buffer-size.rst => userspace-api/media/dvb/ca-send-msg.rst} (51%) rename Documentation/{media/uapi/dvb/ca-get-slot-info.rst => userspace-api/media/dvb/ca-set-descr.rst} (52%) rename Documentation/{media/uapi => userspace-api/media}/dvb/ca.rst (94%) rename Documentation/{media/uapi/v4l/capture-example.rst => userspace-api/media/dvb/ca_data_types.rst} (69%) rename Documentation/{media/uapi/rc/lirc-header.rst => userspace-api/media/dvb/ca_function_calls.rst} (56%) rename Documentation/{media/uapi => userspace-api/media}/dvb/ca_high_level.rst (100%) rename Documentation/{media/uapi => userspace-api/media}/dvb/demux.rst (94%) rename Documentation/{media/uapi/dvb/ca-set-descr.rst => userspace-api/media/dvb/dmx-add-pid.rst} (59%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-expbuf.rst (97%) rename Documentation/{media/uapi/dvb/ca-get-cap.rst => userspace-api/media/dvb/dmx-fclose.rst} (58%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-fopen.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-fread.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-fwrite.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-get-pes-pids.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-get-stc.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-mmap.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-munmap.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-qbuf.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-querybuf.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-remove-pid.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-reqbufs.rst (98%) rename Documentation/{media/uapi/dvb/ca-send-msg.rst => userspace-api/media/dvb/dmx-set-buffer-size.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx-set-filter.rst (96%) rename Documentation/{media/uapi/dvb/dmx-start.rst => userspace-api/media/dvb/dmx-set-pes-filter.rst} (65%) rename Documentation/{media/uapi/dvb/dmx-set-pes-filter.rst => userspace-api/media/dvb/dmx-start.rst} (66%) rename Documentation/{media/uapi/dvb/fe-read-snr.rst => userspace-api/media/dvb/dmx-stop.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dmx_fcalls.rst (93%) rename Documentation/{media/uapi/dvb/frontend-header.rst => userspace-api/media/dvb/dmx_types.rst} (70%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dvb-fe-read-status.rst (95%) rename Documentation/{media/uapi/dvb/ca_data_types.rst => userspace-api/media/dvb/dvb-frontend-event.rst} (60%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dvb-frontend-parameters.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dvbapi.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dvbproperty.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/dvb/dvbstb.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/dvb/examples.rst (93%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-bandwidth-t.rst (95%) rename Documentation/{media/uapi/dvb/fe-get-frontend.rst => userspace-api/media/dvb/fe-diseqc-recv-slave-reply.rst} (50%) rename Documentation/{media/uapi/dvb/fe-diseqc-recv-slave-reply.rst => userspace-api/media/dvb/fe-diseqc-reset-overload.rst} (53%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-diseqc-send-burst.rst (96%) rename Documentation/{media/uapi/dvb/dmx-add-pid.rst => userspace-api/media/dvb/fe-diseqc-send-master-cmd.rst} (50%) rename Documentation/{media/uapi/dvb/fe-diseqc-reset-overload.rst => userspace-api/media/dvb/fe-dishnetwork-send-legacy-cmd.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-enable-high-lnb-voltage.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-get-event.rst (96%) rename Documentation/{media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst => userspace-api/media/dvb/fe-get-frontend.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-get-info.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-get-property.rst (97%) rename Documentation/{media/uapi/dvb/ca-get-msg.rst => userspace-api/media/dvb/fe-read-ber.rst} (52%) rename Documentation/{media/uapi/dvb/fe-read-ber.rst => userspace-api/media/dvb/fe-read-signal-strength.rst} (60%) rename Documentation/{media/uapi/dvb/ca-fclose.rst => userspace-api/media/dvb/fe-read-snr.rst} (52%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-read-status.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-read-uncorrected-blocks.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-set-frontend-tune-mode.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-set-frontend.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-set-tone.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-set-voltage.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe-type-t.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/fe_property_parameters.rst (99%) rename Documentation/{media/uapi/v4l/sdr-formats.rst => userspace-api/media/dvb/frontend-header.rst} (52%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend-property-cable-systems.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend-property-satellite-systems.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend-property-terrestrial-systems.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend-stat-properties.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend.rst (97%) rename Documentation/{media/uapi/dvb/fe-read-signal-strength.rst => userspace-api/media/dvb/frontend_f_close.rst} (57%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend_f_open.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend_fcalls.rst (93%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend_legacy_api.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/dvb/frontend_legacy_dvbv3_api.rst (93%) rename Documentation/{media/uapi => userspace-api/media}/dvb/headers.rst (93%) rename Documentation/{media/uapi => userspace-api/media}/dvb/intro.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/dvb/legacy_dvb_apis.rst (95%) create mode 100644 Documentation/userspace-api/media/dvb/net-add-if.rst rename Documentation/{media/uapi/dvb/net-add-if.rst => userspace-api/media/dvb/net-get-if.rst} (58%) rename Documentation/{media/uapi/dvb/net-get-if.rst => userspace-api/media/dvb/net-remove-if.rst} (54%) rename Documentation/{media/uapi/dvb/dvb-frontend-event.rst => userspace-api/media/dvb/net-types.rst} (61%) rename Documentation/{media/uapi => userspace-api/media}/dvb/net.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/query-dvb-frontend-info.rst (93%) rename Documentation/{media/uapi/dvb/audio-select-source.rst => userspace-api/media/dvb/video-clear-buffer.rst} (55%) create mode 100644 Documentation/userspace-api/media/dvb/video-command.rst rename Documentation/{media/uapi/dvb/video-get-size.rst => userspace-api/media/dvb/video-continue.rst} (65%) rename Documentation/{media/uapi/dvb/video-try-command.rst => userspace-api/media/dvb/video-fast-forward.rst} (55%) rename Documentation/{media/uapi/dvb/video-fwrite.rst => userspace-api/media/dvb/video-fclose.rst} (50%) rename Documentation/{media/uapi/dvb/audio-fopen.rst => userspace-api/media/dvb/video-fopen.rst} (53%) rename Documentation/{media/uapi/dvb/video-set-format.rst => userspace-api/media/dvb/video-freeze.rst} (50%) rename Documentation/{media/uapi/dvb/video-slowmotion.rst => userspace-api/media/dvb/video-fwrite.rst} (50%) rename Documentation/{media/uapi/dvb/audio-channel-select.rst => userspace-api/media/dvb/video-get-capabilities.rst} (53%) rename Documentation/{media/uapi => userspace-api/media}/dvb/video-get-event.rst (98%) rename Documentation/{media/uapi/dvb/video-clear-buffer.rst => userspace-api/media/dvb/video-get-frame-count.rst} (56%) rename Documentation/{media/uapi/dvb/video-set-display-format.rst => userspace-api/media/dvb/video-get-pts.rst} (54%) rename Documentation/{media/uapi/dvb/audio-set-mute.rst => userspace-api/media/dvb/video-get-size.rst} (58%) rename Documentation/{media/uapi/dvb/video-play.rst => userspace-api/media/dvb/video-get-status.rst} (50%) rename Documentation/{media/uapi/dvb/video-fast-forward.rst => userspace-api/media/dvb/video-play.rst} (58%) rename Documentation/{media/uapi => userspace-api/media}/dvb/video-select-source.rst (97%) rename Documentation/{media/uapi/dvb/video-get-status.rst => userspace-api/media/dvb/video-set-blank.rst} (50%) rename Documentation/{media/uapi/dvb/audio-set-bypass-mode.rst => userspace-api/media/dvb/video-set-display-format.rst} (50%) rename Documentation/{media/uapi/dvb/video-get-frame-count.rst => userspace-api/media/dvb/video-set-format.rst} (51%) rename Documentation/{media/uapi/dvb/audio-stop.rst => userspace-api/media/dvb/video-set-streamtype.rst} (56%) rename Documentation/{media/uapi/dvb/audio-set-av-sync.rst => userspace-api/media/dvb/video-slowmotion.rst} (52%) rename Documentation/{media/uapi/dvb/video-freeze.rst => userspace-api/media/dvb/video-stillpicture.rst} (55%) rename Documentation/{media/uapi/dvb/video-get-pts.rst => userspace-api/media/dvb/video-stop.rst} (54%) rename Documentation/{media/uapi/dvb/video-command.rst => userspace-api/media/dvb/video-try-command.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/dvb/video.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/dvb/video_function_calls.rst (94%) rename Documentation/{media/uapi => userspace-api/media}/dvb/video_types.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/fdl-appendix.rst (99%) rename Documentation/{ => userspace-api}/media/frontend.h.rst.exceptions (100%) rename Documentation/{media/uapi => userspace-api/media}/gen-errors.rst (98%) rename Documentation/{media/media_uapi.rst => userspace-api/media/index.rst} (80%) rename Documentation/{ => userspace-api}/media/intro.rst (100%) rename Documentation/{ => userspace-api}/media/lirc.h.rst.exceptions (100%) rename Documentation/{ => userspace-api}/media/media.h.rst.exceptions (100%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-controller-intro.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-controller-model.rst (97%) rename Documentation/{media/uapi/cec/cec-api.rst => userspace-api/media/mediactl/media-controller.rst} (52%) rename Documentation/{media/uapi/cec/cec-func-close.rst => userspace-api/media/mediactl/media-func-close.rst} (61%) rename Documentation/{media/uapi/cec/cec-func-ioctl.rst => userspace-api/media/mediactl/media-func-ioctl.rst} (63%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-func-open.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-funcs.rst (93%) rename Documentation/{media/uapi/v4l/selection-api-targets.rst => userspace-api/media/mediactl/media-header.rst} (52%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-ioc-device-info.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-ioc-enum-entities.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-ioc-enum-links.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-ioc-g-topology.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-ioc-request-alloc.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-ioc-setup-link.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-request-ioc-queue.rst (98%) rename Documentation/{media/uapi/mediactl/request-func-ioctl.rst => userspace-api/media/mediactl/media-request-ioc-reinit.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/media-types.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/request-api.rst (99%) rename Documentation/{media/uapi/v4l/pixfmt-meta-vivid.rst => userspace-api/media/mediactl/request-func-close.rst} (53%) rename Documentation/{media/uapi/mediactl/media-request-ioc-reinit.rst => userspace-api/media/mediactl/request-func-ioctl.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/mediactl/request-func-poll.rst (98%) rename Documentation/{ => userspace-api}/media/net.h.rst.exceptions (100%) rename Documentation/{media/uapi => userspace-api/media}/rc/keytable.c.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-dev-intro.rst (99%) rename Documentation/{media/uapi/cec/cec-header.rst => userspace-api/media/rc/lirc-dev.rst} (67%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-func.rst (94%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-get-features.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-get-rec-mode.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-get-rec-resolution.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-get-send-mode.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-get-timeout.rst (96%) rename Documentation/{media/uapi/cec/cec-funcs.rst => userspace-api/media/rc/lirc-header.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-read.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-set-measure-carrier-mode.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-set-rec-carrier-range.rst (96%) rename Documentation/{media/uapi/rc/lirc-set-send-carrier.rst => userspace-api/media/rc/lirc-set-rec-carrier.rst} (55%) rename Documentation/{media/uapi/rc/lirc-set-rec-carrier.rst => userspace-api/media/rc/lirc-set-rec-timeout-reports.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-set-rec-timeout.rst (96%) rename Documentation/{media/uapi/dvb/frontend_f_close.rst => userspace-api/media/rc/lirc-set-send-carrier.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-set-send-duty-cycle.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-set-transmitter-mask.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-set-wideband-receiver.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/rc/lirc-write.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/rc/rc-intro.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/rc/rc-protos.rst (100%) rename Documentation/{media/uapi => userspace-api/media}/rc/rc-sysfs-nodes.rst (98%) rename Documentation/{media/uapi/v4l/hsv-formats.rst => userspace-api/media/rc/rc-table-change.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/rc/rc-tables.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/rc/remote_controllers.rst (95%) rename Documentation/{ => userspace-api}/media/typical_media_device.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/app-pri.rst (96%) rename Documentation/{media/uapi/dvb/net-types.rst => userspace-api/media/v4l/async.rst} (72%) rename Documentation/{media/uapi => userspace-api/media}/v4l/audio.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/bayer.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/biblio.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/buffer.rst (99%) rename Documentation/{media/uapi/rc/lirc-dev.rst => userspace-api/media/v4l/capture-example.rst} (73%) rename Documentation/{media/uapi => userspace-api/media}/v4l/capture.c.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/colorspaces-defs.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/colorspaces-details.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/colorspaces.rst (99%) rename Documentation/{media/uapi/v4l/v4l2grab-example.rst => userspace-api/media/v4l/common-defs.rst} (54%) rename Documentation/{media/uapi => userspace-api/media}/v4l/common.rst (96%) rename Documentation/{media/uapi/v4l/devices.rst => userspace-api/media/v4l/compat.rst} (59%) rename Documentation/{media/uapi => userspace-api/media}/v4l/constraints.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/control.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/crop.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/crop.svg (99%) rename Documentation/{media/uapi/dvb/ca_function_calls.rst => userspace-api/media/v4l/depth-formats.rst} (61%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-capture.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-decoder.rst (100%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-event.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-mem2mem.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-meta.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-osd.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-output.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-overlay.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-radio.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-raw-vbi.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-rds.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-sdr.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-sliced-vbi.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-stateless-decoder.rst (100%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-subdev.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dev-touch.rst (97%) rename Documentation/{media/uapi/v4l/tch-formats.rst => userspace-api/media/v4l/devices.rst} (58%) rename Documentation/{media/uapi => userspace-api/media}/v4l/diff-v4l.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dmabuf.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/dv-timings.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-camera.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-codec.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-detect.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-dv.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-flash.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-fm-rx.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-fm-tx.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-image-process.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-image-source.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-jpeg.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/ext-ctrls-rf-tuner.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/extended-controls.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/field-order.rst (99%) rename Documentation/{media/uapi/v4l/fieldseq_tb.svg => userspace-api/media/v4l/fieldseq_bt.svg} (51%) rename Documentation/{media/uapi/v4l/fieldseq_bt.svg => userspace-api/media/v4l/fieldseq_tb.svg} (51%) rename Documentation/{media/uapi => userspace-api/media}/v4l/format.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-close.rst (95%) rename Documentation/{media/uapi/mediactl/media-func-ioctl.rst => userspace-api/media/v4l/func-ioctl.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-mmap.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-munmap.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-open.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-poll.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-read.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-select.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/func-write.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/hist-v4l2.rst (99%) rename Documentation/{media/uapi/rc/rc-table-change.rst => userspace-api/media/v4l/hsv-formats.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/v4l/io.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/libv4l-introduction.rst (99%) rename Documentation/{media/uapi/v4l/selection-api.rst => userspace-api/media/v4l/libv4l.rst} (56%) rename Documentation/{media/uapi => userspace-api/media}/v4l/meta-formats.rst (92%) rename Documentation/{media/uapi => userspace-api/media}/v4l/mmap.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/nv12mt.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/nv12mt_example.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/open.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pipeline.dot (100%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-bayer.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-cnf4.rst (100%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-compressed.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-grey.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-indexed.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-intro.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-inzi.rst (97%) rename Documentation/{media/uapi/v4l/pixfmt-vyuy.rst => userspace-api/media/v4l/pixfmt-m420.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-meta-d4xx.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-meta-intel-ipu3.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-meta-uvc.rst (97%) rename Documentation/{media/uapi/mediactl/request-func-close.rst => userspace-api/media/v4l/pixfmt-meta-vivid.rst} (53%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-meta-vsp1-hgo.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-meta-vsp1-hgt.rst (98%) rename Documentation/{media/uapi/v4l/pixfmt-nv16.rst => userspace-api/media/v4l/pixfmt-nv12.rst} (64%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-nv12m.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-nv12mt.rst (97%) rename Documentation/{media/uapi/v4l/pixfmt-nv16m.rst => userspace-api/media/v4l/pixfmt-nv16.rst} (52%) create mode 100644 Documentation/userspace-api/media/v4l/pixfmt-nv16m.rst rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-nv24.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-packed-hsv.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-packed-yuv.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-reserved.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-rgb.rst (99%) rename Documentation/{media/uapi/v4l/pixfmt-sdr-ru12le.rst => userspace-api/media/v4l/pixfmt-sdr-cs08.rst} (53%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-sdr-cs14le.rst (95%) rename Documentation/{media/uapi/v4l/pixfmt-sdr-cu16le.rst => userspace-api/media/v4l/pixfmt-sdr-cu08.rst} (60%) rename Documentation/{media/uapi/v4l/pixfmt-sdr-cs08.rst => userspace-api/media/v4l/pixfmt-sdr-cu16le.rst} (60%) rename Documentation/{media/uapi/v4l/pixfmt-sdr-pcu20be.rst => userspace-api/media/v4l/pixfmt-sdr-pcu16be.rst} (63%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-sdr-pcu18be.rst (97%) rename Documentation/{media/uapi/v4l/pixfmt-sdr-pcu16be.rst => userspace-api/media/v4l/pixfmt-sdr-pcu20be.rst} (63%) rename Documentation/{media/uapi/v4l/pixfmt-sdr-cu08.rst => userspace-api/media/v4l/pixfmt-sdr-ru12le.rst} (53%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-srggb10-ipu3.rst (99%) rename Documentation/{media/uapi/v4l/pixfmt-srggb14.rst => userspace-api/media/v4l/pixfmt-srggb10.rst} (64%) rename Documentation/{media/uapi/v4l/pixfmt-srggb10dpcm8.rst => userspace-api/media/v4l/pixfmt-srggb10alaw8.rst} (55%) rename Documentation/{media/uapi/v4l/pixfmt-srggb10alaw8.rst => userspace-api/media/v4l/pixfmt-srggb10dpcm8.rst} (55%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-srggb10p.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-srggb12.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-srggb12p.rst (98%) rename Documentation/{media/uapi/v4l/pixfmt-srggb10.rst => userspace-api/media/v4l/pixfmt-srggb14.rst} (64%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-srggb14p.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-srggb16.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-srggb8.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-tch-td08.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-tch-td16.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-tch-tu08.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-tch-tu16.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-uv8.rst (95%) rename Documentation/{media/uapi/v4l/pixfmt-y41p.rst => userspace-api/media/v4l/pixfmt-uyvy.rst} (57%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-v4l2-mplane.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-v4l2.rst (99%) rename Documentation/{media/uapi/v4l/pixfmt-uyvy.rst => userspace-api/media/v4l/pixfmt-vyuy.rst} (79%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-y10.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-y10b.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-y10p.rst (96%) rename Documentation/{media/uapi/v4l/pixfmt-y16-be.rst => userspace-api/media/v4l/pixfmt-y12.rst} (53%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-y12i.rst (95%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-y14.rst (96%) rename Documentation/{media/uapi/v4l/pixfmt-y16.rst => userspace-api/media/v4l/pixfmt-y16-be.rst} (61%) rename Documentation/{media/uapi/v4l/pixfmt-y12.rst => userspace-api/media/v4l/pixfmt-y16.rst} (83%) rename Documentation/{media/uapi/v4l/pixfmt-yvyu.rst => userspace-api/media/v4l/pixfmt-y41p.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-y8i.rst (97%) rename Documentation/{media/uapi/v4l/pixfmt-yuv411p.rst => userspace-api/media/v4l/pixfmt-yuv410.rst} (53%) rename Documentation/{media/uapi/v4l/pixfmt-yuv410.rst => userspace-api/media/v4l/pixfmt-yuv411p.rst} (53%) rename Documentation/{media/uapi/v4l/pixfmt-nv12.rst => userspace-api/media/v4l/pixfmt-yuv420.rst} (52%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-yuv420m.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-yuv422m.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-yuv422p.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-yuv444m.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-yuyv.rst (97%) rename Documentation/{media/uapi/v4l/pixfmt-m420.rst => userspace-api/media/v4l/pixfmt-yvyu.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt-z16.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/pixfmt.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/planar-apis.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/querycap.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/rw.rst (97%) rename Documentation/{media/uapi/dvb/dmx_types.rst => userspace-api/media/v4l/sdr-formats.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/v4l/selection-api-configuration.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/selection-api-examples.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/selection-api-intro.rst (96%) rename Documentation/{media/uapi/v4l/common-defs.rst => userspace-api/media/v4l/selection-api-targets.rst} (52%) rename Documentation/{media/uapi => userspace-api/media}/v4l/selection-api-vs-crop-api.rst (97%) rename Documentation/{media/uapi/v4l/async.rst => userspace-api/media/v4l/selection-api.rst} (51%) rename Documentation/{media/uapi => userspace-api/media}/v4l/selection.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/selections-common.rst (94%) rename Documentation/{media/uapi => userspace-api/media}/v4l/standard.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/streaming-par.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/subdev-formats.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/subdev-image-processing-crop.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/subdev-image-processing-full.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/subdev-image-processing-scaling-multi-source.svg (99%) rename Documentation/{media/uapi/v4l/videodev.rst => userspace-api/media/v4l/tch-formats.rst} (58%) rename Documentation/{media/uapi => userspace-api/media}/v4l/tuner.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/user-func.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/userp.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/v4l2-selection-flags.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/v4l2-selection-targets.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/v4l2.rst (99%) rename Documentation/{media/uapi/mediactl/media-header.rst => userspace-api/media/v4l/v4l2grab-example.rst} (50%) rename Documentation/{media/uapi => userspace-api/media}/v4l/v4l2grab.c.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vbi_525.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vbi_625.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vbi_hsync.svg (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/video.rst (97%) rename Documentation/{media/uapi/v4l/compat.rst => userspace-api/media/v4l/videodev.rst} (55%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-create-bufs.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-cropcap.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-dbg-g-chip-info.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-dbg-g-register.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-decoder-cmd.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-dqevent.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-dv-timings-cap.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-encoder-cmd.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enum-dv-timings.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enum-fmt.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enum-frameintervals.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enum-framesizes.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enum-freq-bands.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enumaudio.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enumaudioout.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enuminput.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enumoutput.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-enumstd.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-expbuf.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-audio.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-audioout.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-crop.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-ctrl.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-dv-timings.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-edid.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-enc-index.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-ext-ctrls.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-fbuf.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-fmt.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-frequency.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-input.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-jpegcomp.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-modulator.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-output.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-parm.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-priority.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-selection.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-sliced-vbi-cap.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-std.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-g-tuner.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-log-status.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-overlay.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-prepare-buf.rst (96%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-qbuf.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-query-dv-timings.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-querybuf.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-querycap.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-queryctrl.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-querystd.rst (97%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-reqbufs.rst (99%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-s-hw-freq-seek.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-streamon.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subdev-enum-frame-interval.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subdev-enum-frame-size.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subdev-enum-mbus-code.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subdev-g-crop.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subdev-g-fmt.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subdev-g-frame-interval.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subdev-g-selection.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/vidioc-subscribe-event.rst (98%) rename Documentation/{media/uapi => userspace-api/media}/v4l/yuv-formats.rst (97%) rename Documentation/{ => userspace-api}/media/video.h.rst.exceptions (100%) rename Documentation/{ => userspace-api}/media/videodev2.h.rst.exceptions (100%) diff --git a/Documentation/ABI/testing/debugfs-cec-error-inj b/Documentation/ABI/testing/debugfs-cec-error-inj index 4c3596c6d25b..5afcd78fbdb7 100644 --- a/Documentation/ABI/testing/debugfs-cec-error-inj +++ b/Documentation/ABI/testing/debugfs-cec-error-inj @@ -37,4 +37,4 @@ when changes are made. The following CEC error injection implementations exist: -- Documentation/media/uapi/cec/cec-pin-error-inj.rst +- Documentation/userspace-api/media/cec/cec-pin-error-inj.rst diff --git a/Documentation/Makefile b/Documentation/Makefile index cc786d11a028..7e12d10ca8e0 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -55,15 +55,15 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; # $2 sphinx builder e.g. "html" -# $3 name of the build subfolder / e.g. "media", used as: +# $3 name of the build subfolder / e.g. "userspace-api/media", used as: # * dest folder relative to $(BUILDDIR) and # * cache folder relative to $(BUILDDIR)/.doctrees -# $4 dest subfolder e.g. "man" for man pages at media/man +# $4 dest subfolder e.g. "man" for man pages at userspace-api/media/man # $5 reST source folder relative to $(srctree)/$(src), -# e.g. "media" for the linux-tv book-set at ./Documentation/media +# e.g. "userspace-api/media" for the linux-tv book-set at ./Documentation/userspace-api/media quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) - cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media $2 && \ + cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media $2 && \ PYTHONDONTWRITEBYTECODE=1 \ BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ $(PYTHON) $(srctree)/scripts/jobserver-exec \ @@ -120,7 +120,7 @@ refcheckdocs: cleandocs: $(Q)rm -rf $(BUILDDIR) - $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/media clean + $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=Documentation/userspace-api/media clean dochelp: @echo ' Linux kernel internal documentation in different formats from ReST:' diff --git a/Documentation/doc-guide/parse-headers.rst b/Documentation/doc-guide/parse-headers.rst index 24cfaa15dd81..f7135b058246 100644 --- a/Documentation/doc-guide/parse-headers.rst +++ b/Documentation/doc-guide/parse-headers.rst @@ -10,7 +10,7 @@ if a symbol is not found at the documentation. That helps to keep the uAPI documentation in sync with the Kernel changes. The :ref:`parse_headers.pl ` provide a way to generate such cross-references. It has to be called via Makefile, while building the -documentation. Please see ``Documentation/media/Makefile`` for an example +documentation. Please see ``Documentation/userspace-api/media/Makefile`` for an example about how to use it inside the Kernel tree. .. _parse_headers: diff --git a/Documentation/fb/api.rst b/Documentation/fb/api.rst index 79ec33dded74..4f00e7196fef 100644 --- a/Documentation/fb/api.rst +++ b/Documentation/fb/api.rst @@ -290,12 +290,12 @@ the FB_CAP_FOURCC bit in the fb_fix_screeninfo capabilities field. FOURCC definitions are located in the linux/videodev2.h header. However, and despite starting with the V4L2_PIX_FMT_prefix, they are not restricted to V4L2 and don't require usage of the V4L2 subsystem. FOURCC documentation is -available in Documentation/media/uapi/v4l/pixfmt.rst. +available in Documentation/userspace-api/media/v4l/pixfmt.rst. To select a format, applications set the grayscale field to the desired FOURCC. For YUV formats, they should also select the appropriate colorspace by setting the colorspace field to one of the colorspaces listed in linux/videodev2.h and -documented in Documentation/media/uapi/v4l/colorspaces.rst. +documented in Documentation/userspace-api/media/v4l/colorspaces.rst. The red, green, blue and transp fields are not used with the FOURCC-based API. For forward compatibility reasons applications must zero those fields, and diff --git a/Documentation/media/index.rst b/Documentation/media/index.rst index 0301c25ff887..8118c2d001ff 100644 --- a/Documentation/media/index.rst +++ b/Documentation/media/index.rst @@ -12,7 +12,7 @@ Linux Media Subsystem Documentation .. toctree:: :maxdepth: 2 - media_uapi + ../userspace-api/media/index media_kapi dvb-drivers/index v4l-drivers/index diff --git a/Documentation/media/uapi/dvb/audio-bilingual-channel-select.rst b/Documentation/media/uapi/dvb/audio-bilingual-channel-select.rst deleted file mode 100644 index ee2ee74dafa3..000000000000 --- a/Documentation/media/uapi/dvb/audio-bilingual-channel-select.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. Permission is granted to copy, distribute and/or modify this -.. document under the terms of the GNU Free Documentation License, -.. Version 1.1 or any later version published by the Free Software -.. Foundation, with no Invariant Sections, no Front-Cover Texts -.. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. -.. -.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections - -.. _AUDIO_BILINGUAL_CHANNEL_SELECT: - -============================== -AUDIO_BILINGUAL_CHANNEL_SELECT -============================== - -Name ----- - -AUDIO_BILINGUAL_CHANNEL_SELECT - -.. attention:: This ioctl is deprecated - -Synopsis --------- - -.. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select) - :name: AUDIO_BILINGUAL_CHANNEL_SELECT - - -Arguments ---------- - -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - - - int fd - - - File descriptor returned by a previous call to open(). - - - - - - audio_channel_select_t ch - - - Select the output format of the audio (mono left/right, stereo). - - -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 ` chapter. diff --git a/Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst b/Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst deleted file mode 100644 index d06d69414c1e..000000000000 --- a/Documentation/media/uapi/rc/lirc-set-rec-timeout-reports.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. Permission is granted to copy, distribute and/or modify this -.. document under the terms of the GNU Free Documentation License, -.. Version 1.1 or any later version published by the Free Software -.. Foundation, with no Invariant Sections, no Front-Cover Texts -.. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. -.. -.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections - -.. _lirc_set_rec_timeout_reports: - -********************************** -ioctl LIRC_SET_REC_TIMEOUT_REPORTS -********************************** - -Name -==== - -LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive - -Synopsis -======== - -.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable ) - :name: LIRC_SET_REC_TIMEOUT_REPORTS - -Arguments -========= - -``fd`` - File descriptor returned by open(). - -``enable`` - enable = 1 means enable timeout report, enable = 0 means disable timeout - reports. - - -Description -=========== - -.. _lirc-mode2-timeout: - -Enable or disable timeout reports for IR receive. By default, timeout reports -should be turned off. - -.. note:: - - This ioctl is only valid for :ref:`LIRC_MODE_MODE2 `. - - -Return 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 ` chapter. diff --git a/Documentation/media/uapi/v4l/pixfmt-yuv420.rst b/Documentation/media/uapi/v4l/pixfmt-yuv420.rst deleted file mode 100644 index f4f6f792a23e..000000000000 --- a/Documentation/media/uapi/v4l/pixfmt-yuv420.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. Permission is granted to copy, distribute and/or modify this -.. document under the terms of the GNU Free Documentation License, -.. Version 1.1 or any later version published by the Free Software -.. Foundation, with no Invariant Sections, no Front-Cover Texts -.. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. -.. -.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections - -.. _V4L2-PIX-FMT-YVU420: -.. _V4L2-PIX-FMT-YUV420: - -********************************************************** -V4L2_PIX_FMT_YVU420 ('YV12'), V4L2_PIX_FMT_YUV420 ('YU12') -********************************************************** - - -V4L2_PIX_FMT_YUV420 -Planar formats with ½ horizontal and vertical chroma resolution, also -known as YUV 4:2:0 - - -Description -=========== - -These are planar formats, as opposed to a packed format. The three -components are separated into three sub- images or planes. The Y plane -is first. The Y plane has one byte per pixel. For -``V4L2_PIX_FMT_YVU420``, the Cr plane immediately follows the Y plane in -memory. The Cr plane is half the width and half the height of the Y -plane (and of the image). Each Cr belongs to four pixels, a two-by-two -square of the image. For example, Cr\ :sub:`0` belongs to Y'\ :sub:`00`, -Y'\ :sub:`01`, Y'\ :sub:`10`, and Y'\ :sub:`11`. Following the Cr plane -is the Cb plane, just like the Cr plane. ``V4L2_PIX_FMT_YUV420`` is the -same except the Cb plane comes first, then the Cr plane. - -If the Y plane has pad bytes after each row, then the Cr and Cb planes -have half as many pad bytes after their rows. In other words, two Cx -rows (including padding) is exactly as long as one Y row (including -padding). - -**Byte Order.** -Each cell is one byte. - - - - -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - * - start + 0: - - Y'\ :sub:`00` - - Y'\ :sub:`01` - - Y'\ :sub:`02` - - Y'\ :sub:`03` - * - start + 4: - - Y'\ :sub:`10` - - Y'\ :sub:`11` - - Y'\ :sub:`12` - - Y'\ :sub:`13` - * - start + 8: - - Y'\ :sub:`20` - - Y'\ :sub:`21` - - Y'\ :sub:`22` - - Y'\ :sub:`23` - * - start + 12: - - Y'\ :sub:`30` - - Y'\ :sub:`31` - - Y'\ :sub:`32` - - Y'\ :sub:`33` - * - start + 16: - - Cr\ :sub:`00` - - Cr\ :sub:`01` - * - start + 18: - - Cr\ :sub:`10` - - Cr\ :sub:`11` - * - start + 20: - - Cb\ :sub:`00` - - Cb\ :sub:`01` - * - start + 22: - - Cb\ :sub:`10` - - Cb\ :sub:`11` - - -**Color Sample Location:** - - - -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - * - - - 0 - - - - 1 - - - - 2 - - - - 3 - * - 0 - - Y - - - - Y - - - - Y - - - - Y - * - - - - - C - - - - - - - - C - - - * - 1 - - Y - - - - Y - - - - Y - - - - Y - * - - * - 2 - - Y - - - - Y - - - - Y - - - - Y - * - - - - - C - - - - - - - - C - - - * - 3 - - Y - - - - Y - - - - Y - - - - Y diff --git a/Documentation/translations/it_IT/doc-guide/parse-headers.rst b/Documentation/translations/it_IT/doc-guide/parse-headers.rst index b38918ca637e..993d549ee2b8 100644 --- a/Documentation/translations/it_IT/doc-guide/parse-headers.rst +++ b/Documentation/translations/it_IT/doc-guide/parse-headers.rst @@ -17,7 +17,7 @@ con le modifiche del kernel. Il programma :ref:`parse_headers.pl ` genera questi riferimenti. Esso dev'essere invocato attraverso un Makefile, mentre si genera la documentazione. Per avere un esempio su come utilizzarlo all'interno del kernel -consultate ``Documentation/media/Makefile``. +consultate ``Documentation/userspace-api/media/Makefile``. .. _it_parse_headers: diff --git a/Documentation/media/Makefile b/Documentation/userspace-api/media/Makefile similarity index 97% rename from Documentation/media/Makefile rename to Documentation/userspace-api/media/Makefile index d75d70f191bc..81a4a1a53bce 100644 --- a/Documentation/media/Makefile +++ b/Documentation/userspace-api/media/Makefile @@ -2,7 +2,7 @@ # Rules to convert a .h file to inline RST documentation -SRC_DIR=$(srctree)/Documentation/media +SRC_DIR=$(srctree)/Documentation/userspace-api/media PARSER = $(srctree)/Documentation/sphinx/parse-headers.pl UAPI = $(srctree)/include/uapi/linux KAPI = $(srctree)/include/linux diff --git a/Documentation/media/audio.h.rst.exceptions b/Documentation/userspace-api/media/audio.h.rst.exceptions similarity index 100% rename from Documentation/media/audio.h.rst.exceptions rename to Documentation/userspace-api/media/audio.h.rst.exceptions diff --git a/Documentation/media/ca.h.rst.exceptions b/Documentation/userspace-api/media/ca.h.rst.exceptions similarity index 100% rename from Documentation/media/ca.h.rst.exceptions rename to Documentation/userspace-api/media/ca.h.rst.exceptions diff --git a/Documentation/media/cec.h.rst.exceptions b/Documentation/userspace-api/media/cec.h.rst.exceptions similarity index 100% rename from Documentation/media/cec.h.rst.exceptions rename to Documentation/userspace-api/media/cec.h.rst.exceptions diff --git a/Documentation/media/uapi/mediactl/media-controller.rst b/Documentation/userspace-api/media/cec/cec-api.rst similarity index 53% rename from Documentation/media/uapi/mediactl/media-controller.rst rename to Documentation/userspace-api/media/cec/cec-api.rst index 6e624f690331..871db54dfd24 100644 --- a/Documentation/media/uapi/mediactl/media-controller.rst +++ b/Documentation/userspace-api/media/cec/cec-api.rst @@ -3,17 +3,20 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections .. include:: -.. _media_controller: +.. _cec: + +######################################### +Part V - Consumer Electronics Control API +######################################### + +This part describes the CEC: Consumer Electronics Control -############################## -Part IV - Media Controller API -############################## .. only:: html @@ -25,38 +28,27 @@ Part IV - Media Controller API :maxdepth: 5 :numbered: - media-controller-intro - media-controller-model - media-types - request-api - media-funcs - media-header + cec-intro + cec-funcs + cec-pin-error-inj + cec-header ********************** Revision and Copyright ********************** - Authors: -- Pinchart, Laurent +- Verkuil, Hans - Initial version. -- Carvalho Chehab, Mauro - - - MEDIA_IOC_G_TOPOLOGY documentation and documentation improvements. - -**Copyright** |copy| 2010 : Laurent Pinchart - -**Copyright** |copy| 2015-2016 : Mauro Carvalho Chehab +**Copyright** |copy| 2016 : Hans Verkuil **************** Revision History **************** -:revision: 1.1.0 / 2015-12-12 (*mcc*) - -:revision: 1.0.0 / 2010-11-10 (*lp*) +:revision: 1.0.0 / 2016-03-17 (*hv*) Initial revision diff --git a/Documentation/media/uapi/mediactl/media-func-close.rst b/Documentation/userspace-api/media/cec/cec-func-close.rst similarity index 61% rename from Documentation/media/uapi/mediactl/media-func-close.rst rename to Documentation/userspace-api/media/cec/cec-func-close.rst index 369ccd4dee56..b89e06a43dad 100644 --- a/Documentation/media/uapi/mediactl/media-func-close.rst +++ b/Documentation/userspace-api/media/cec/cec-func-close.rst @@ -3,20 +3,20 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _media-func-close: +.. _cec-func-close: -************* -media close() -************* +*********** +cec close() +*********** Name ==== -media-close - Close a media device +cec-close - Close a cec device Synopsis @@ -28,27 +28,27 @@ Synopsis .. c:function:: int close( int fd ) - :name: mc-close + :name: cec-close Arguments ========= ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by :c:func:`open() `. Description =========== -Closes the media device. Resources associated with the file descriptor -are freed. The device configuration remain unchanged. +Closes the cec device. Resources associated with the file descriptor are +freed. The device configuration remain unchanged. Return Value ============ -:ref:`close() ` returns 0 on success. On error, -1 is returned, and +:c:func:`close() ` returns 0 on success. On error, -1 is returned, and ``errno`` is set appropriately. Possible error codes are: -EBADF +``EBADF`` ``fd`` is not a valid open file descriptor. diff --git a/Documentation/media/uapi/v4l/func-ioctl.rst b/Documentation/userspace-api/media/cec/cec-func-ioctl.rst similarity index 51% rename from Documentation/media/uapi/v4l/func-ioctl.rst rename to Documentation/userspace-api/media/cec/cec-func-ioctl.rst index e7a8cf62752e..d16a479aacb1 100644 --- a/Documentation/media/uapi/v4l/func-ioctl.rst +++ b/Documentation/userspace-api/media/cec/cec-func-ioctl.rst @@ -3,21 +3,20 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _func-ioctl: +.. _cec-func-ioctl: -************ -V4L2 ioctl() -************ +*********** +cec ioctl() +*********** Name ==== -v4l2-ioctl - Program a V4L2 device - +cec-ioctl - Control a cec device Synopsis ======== @@ -28,34 +27,36 @@ Synopsis .. c:function:: int ioctl( int fd, int request, void *argp ) - :name: v4l2-ioctl + :name: cec-ioctl Arguments ========= ``fd`` - File descriptor returned by :ref:`open() `. + File descriptor returned by :c:func:`open() `. ``request`` - V4L2 ioctl request code as defined in the ``videodev2.h`` header - file, for example VIDIOC_QUERYCAP. + CEC ioctl request code as defined in the cec.h header file, for + example :ref:`CEC_ADAP_G_CAPS `. ``argp`` - Pointer to a function parameter, usually a structure. + Pointer to a request-specific structure. Description =========== -The :ref:`ioctl() ` function is used to program V4L2 devices. The -argument ``fd`` must be an open file descriptor. An ioctl ``request`` +The :c:func:`ioctl() ` function manipulates cec device parameters. The +argument ``fd`` must be an open file descriptor. + +The ioctl ``request`` code specifies the cec function to be called. It has encoded in it whether the argument is an input, output or read/write -parameter, and the size of the argument ``argp`` in bytes. Macros and -defines specifying V4L2 ioctl requests are located in the -``videodev2.h`` header file. Applications should use their own copy, not -include the version in the kernel sources on the system they compile on. -All V4L2 ioctl requests, their respective function and parameters are -specified in :ref:`user-func`. +parameter, and the size of the argument ``argp`` in bytes. + +Macros and structures definitions specifying cec ioctl requests and +their parameters are located in the cec.h header file. All cec ioctl +requests, their respective function and parameters are specified in +:ref:`cec-user-func`. Return Value @@ -65,5 +66,8 @@ 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 ` chapter. +Request-specific error codes are listed in the individual requests +descriptions. + When an ioctl that takes an output or read/write parameter fails, the parameter remains unmodified. diff --git a/Documentation/media/uapi/cec/cec-func-open.rst b/Documentation/userspace-api/media/cec/cec-func-open.rst similarity index 97% rename from Documentation/media/uapi/cec/cec-func-open.rst rename to Documentation/userspace-api/media/cec/cec-func-open.rst index f235aa80155c..67fd021556b2 100644 --- a/Documentation/media/uapi/cec/cec-func-open.rst +++ b/Documentation/userspace-api/media/cec/cec-func-open.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-func-poll.rst b/Documentation/userspace-api/media/cec/cec-func-poll.rst similarity index 97% rename from Documentation/media/uapi/cec/cec-func-poll.rst rename to Documentation/userspace-api/media/cec/cec-func-poll.rst index 3f6c5b0effa3..ed3652d9bf17 100644 --- a/Documentation/media/uapi/cec/cec-func-poll.rst +++ b/Documentation/userspace-api/media/cec/cec-func-poll.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/libv4l.rst b/Documentation/userspace-api/media/cec/cec-funcs.rst similarity index 53% rename from Documentation/media/uapi/v4l/libv4l.rst rename to Documentation/userspace-api/media/cec/cec-funcs.rst index d114fbf1ffa6..88966b5175d2 100644 --- a/Documentation/media/uapi/v4l/libv4l.rst +++ b/Documentation/userspace-api/media/cec/cec-funcs.rst @@ -3,18 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _libv4l: +.. _cec-user-func: -************************ -Libv4l Userspace Library -************************ +****************** +Function Reference +****************** .. toctree:: :maxdepth: 1 - libv4l-introduction + cec-func-open + cec-func-close + cec-func-ioctl + cec-func-poll + cec-ioc-adap-g-caps + cec-ioc-adap-g-log-addrs + cec-ioc-adap-g-phys-addr + cec-ioc-adap-g-conn-info + cec-ioc-dqevent + cec-ioc-g-mode + cec-ioc-receive diff --git a/Documentation/media/uapi/v4l/depth-formats.rst b/Documentation/userspace-api/media/cec/cec-header.rst similarity index 61% rename from Documentation/media/uapi/v4l/depth-formats.rst rename to Documentation/userspace-api/media/cec/cec-header.rst index 1bfd0b82cb85..24a83b0c35af 100644 --- a/Documentation/media/uapi/v4l/depth-formats.rst +++ b/Documentation/userspace-api/media/cec/cec-header.rst @@ -3,22 +3,15 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _depth-formats: +.. _cec_header: -************* -Depth Formats -************* +*************** +CEC Header File +*************** -Depth data provides distance to points, mapped onto the image plane +.. kernel-include:: $BUILDDIR/cec.h.rst - -.. toctree:: - :maxdepth: 1 - - pixfmt-inzi - pixfmt-z16 - pixfmt-cnf4 diff --git a/Documentation/media/uapi/cec/cec-intro.rst b/Documentation/userspace-api/media/cec/cec-intro.rst similarity index 97% rename from Documentation/media/uapi/cec/cec-intro.rst rename to Documentation/userspace-api/media/cec/cec-intro.rst index 05088fcefe81..a4db82388202 100644 --- a/Documentation/media/uapi/cec/cec-intro.rst +++ b/Documentation/userspace-api/media/cec/cec-intro.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst b/Documentation/userspace-api/media/cec/cec-ioc-adap-g-caps.rst similarity index 98% rename from Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst rename to Documentation/userspace-api/media/cec/cec-ioc-adap-g-caps.rst index 76761a98c312..94e46a11d68d 100644 --- a/Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst +++ b/Documentation/userspace-api/media/cec/cec-ioc-adap-g-caps.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-conn-info.rst b/Documentation/userspace-api/media/cec/cec-ioc-adap-g-conn-info.rst similarity index 100% rename from Documentation/media/uapi/cec/cec-ioc-adap-g-conn-info.rst rename to Documentation/userspace-api/media/cec/cec-ioc-adap-g-conn-info.rst diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst b/Documentation/userspace-api/media/cec/cec-ioc-adap-g-log-addrs.rst similarity index 99% rename from Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst rename to Documentation/userspace-api/media/cec/cec-ioc-adap-g-log-addrs.rst index 26465094e3f1..8ba3511c88b8 100644 --- a/Documentation/media/uapi/cec/cec-ioc-adap-g-log-addrs.rst +++ b/Documentation/userspace-api/media/cec/cec-ioc-adap-g-log-addrs.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-ioc-adap-g-phys-addr.rst b/Documentation/userspace-api/media/cec/cec-ioc-adap-g-phys-addr.rst similarity index 98% rename from Documentation/media/uapi/cec/cec-ioc-adap-g-phys-addr.rst rename to Documentation/userspace-api/media/cec/cec-ioc-adap-g-phys-addr.rst index 693be2f9bf2e..ce8f64c3e060 100644 --- a/Documentation/media/uapi/cec/cec-ioc-adap-g-phys-addr.rst +++ b/Documentation/userspace-api/media/cec/cec-ioc-adap-g-phys-addr.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst b/Documentation/userspace-api/media/cec/cec-ioc-dqevent.rst similarity index 99% rename from Documentation/media/uapi/cec/cec-ioc-dqevent.rst rename to Documentation/userspace-api/media/cec/cec-ioc-dqevent.rst index d16b226b1bef..4a535fb64b4b 100644 --- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst +++ b/Documentation/userspace-api/media/cec/cec-ioc-dqevent.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-ioc-g-mode.rst b/Documentation/userspace-api/media/cec/cec-ioc-g-mode.rst similarity index 99% rename from Documentation/media/uapi/cec/cec-ioc-g-mode.rst rename to Documentation/userspace-api/media/cec/cec-ioc-g-mode.rst index 2535b77e3459..2d3227e80b4f 100644 --- a/Documentation/media/uapi/cec/cec-ioc-g-mode.rst +++ b/Documentation/userspace-api/media/cec/cec-ioc-g-mode.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-ioc-receive.rst b/Documentation/userspace-api/media/cec/cec-ioc-receive.rst similarity index 99% rename from Documentation/media/uapi/cec/cec-ioc-receive.rst rename to Documentation/userspace-api/media/cec/cec-ioc-receive.rst index 4137903d672e..e456b2bc92a1 100644 --- a/Documentation/media/uapi/cec/cec-ioc-receive.rst +++ b/Documentation/userspace-api/media/cec/cec-ioc-receive.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-pin-error-inj.rst b/Documentation/userspace-api/media/cec/cec-pin-error-inj.rst similarity index 99% rename from Documentation/media/uapi/cec/cec-pin-error-inj.rst rename to Documentation/userspace-api/media/cec/cec-pin-error-inj.rst index 725f8b1c9965..78632199324d 100644 --- a/Documentation/media/uapi/cec/cec-pin-error-inj.rst +++ b/Documentation/userspace-api/media/cec/cec-pin-error-inj.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/conf_nitpick.py b/Documentation/userspace-api/media/conf_nitpick.py similarity index 100% rename from Documentation/media/conf_nitpick.py rename to Documentation/userspace-api/media/conf_nitpick.py diff --git a/Documentation/media/dmx.h.rst.exceptions b/Documentation/userspace-api/media/dmx.h.rst.exceptions similarity index 100% rename from Documentation/media/dmx.h.rst.exceptions rename to Documentation/userspace-api/media/dmx.h.rst.exceptions diff --git a/Documentation/media/uapi/dvb/video-get-capabilities.rst b/Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst similarity index 50% rename from Documentation/media/uapi/dvb/video-get-capabilities.rst rename to Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst index 971fdab70e15..6841233f3fee 100644 --- a/Documentation/media/uapi/dvb/video-get-capabilities.rst +++ b/Documentation/userspace-api/media/dvb/audio-bilingual-channel-select.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_GET_CAPABILITIES: +.. _AUDIO_BILINGUAL_CHANNEL_SELECT: -====================== -VIDEO_GET_CAPABILITIES -====================== +============================== +AUDIO_BILINGUAL_CHANNEL_SELECT +============================== Name ---- -VIDEO_GET_CAPABILITIES +AUDIO_BILINGUAL_CHANNEL_SELECT -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_GET_CAPABILITIES, unsigned int *cap) - :name: VIDEO_GET_CAPABILITIES +.. c:function:: int ioctl(int fd, AUDIO_BILINGUAL_CHANNEL_SELECT, struct *audio_channel_select) + :name: AUDIO_BILINGUAL_CHANNEL_SELECT Arguments @@ -34,32 +34,28 @@ Arguments :header-rows: 0 :stub-columns: 0 - - - .. row 1 + - - int fd - File descriptor returned by a previous call to open(). - - .. row 2 - - - int request - - - Equals VIDEO_GET_CAPABILITIES for this command. + - - - .. row 3 + - audio_channel_select_t ch - - unsigned int \*cap - - - Pointer to a location where to store the capability information. + - Select the output format of the audio (mono left/right, stereo). Description ----------- -This ioctl call asks the video device about its decoding capabilities. -On success it returns and integer which has bits set according to the -defines in section ??. +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 diff --git a/Documentation/media/uapi/dvb/video-continue.rst b/Documentation/userspace-api/media/dvb/audio-channel-select.rst similarity index 60% rename from Documentation/media/uapi/dvb/video-continue.rst rename to Documentation/userspace-api/media/dvb/audio-channel-select.rst index 2ae2067dfba8..18e880e7eab4 100644 --- a/Documentation/media/uapi/dvb/video-continue.rst +++ b/Documentation/userspace-api/media/dvb/audio-channel-select.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_CONTINUE: +.. _AUDIO_CHANNEL_SELECT: -============== -VIDEO_CONTINUE -============== +==================== +AUDIO_CHANNEL_SELECT +==================== Name ---- -VIDEO_CONTINUE +AUDIO_CHANNEL_SELECT -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_CONTINUE) - :name: VIDEO_CONTINUE +.. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct *audio_channel_select) + :name: AUDIO_CHANNEL_SELECT Arguments @@ -35,27 +35,27 @@ Arguments :stub-columns: 0 - - .. row 1 + - - int fd - File descriptor returned by a previous call to open(). - - .. row 2 + - - - int request + - audio_channel_select_t ch - - Equals VIDEO_CONTINUE for this command. + - Select the output format of the audio (mono left/right, stereo). Description ----------- This ioctl is for Digital TV devices only. To control a V4L2 decoder use the -V4L2 :ref:`VIDIOC_DECODER_CMD` instead. +V4L2 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` control instead. -This ioctl call restarts decoding and playing processes of the video -stream which was played before a call to VIDEO_FREEZE was made. +This ioctl call asks the Audio Device to select the requested channel if +possible. Return Value diff --git a/Documentation/media/uapi/dvb/audio-fclose.rst b/Documentation/userspace-api/media/dvb/audio-clear-buffer.rst similarity index 57% rename from Documentation/media/uapi/dvb/audio-fclose.rst rename to Documentation/userspace-api/media/dvb/audio-clear-buffer.rst index 1e4ad7a0325d..19f2ed752ce2 100644 --- a/Documentation/media/uapi/dvb/audio-fclose.rst +++ b/Documentation/userspace-api/media/dvb/audio-clear-buffer.rst @@ -3,29 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _audio_fclose: +.. _AUDIO_CLEAR_BUFFER: -======================== -Digital TV audio close() -======================== +================== +AUDIO_CLEAR_BUFFER +================== Name ---- -Digital TV audio close() +AUDIO_CLEAR_BUFFER .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int close(int fd) - :name: dvb-audio-close - +.. c:function:: int ioctl(int fd, AUDIO_CLEAR_BUFFER) + :name: AUDIO_CLEAR_BUFFER Arguments --------- @@ -41,23 +40,16 @@ Arguments - File descriptor returned by a previous call to open(). - Description ----------- -This system call closes a previously opened audio device. +This ioctl call asks the Audio Device to clear all software and hardware +buffers of the audio decoder device. Return Value ------------ -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - .. row 1 - - - ``EBADF`` - - - fd is not a valid open file descriptor. +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 ` chapter. diff --git a/Documentation/media/uapi/dvb/audio-clear-buffer.rst b/Documentation/userspace-api/media/dvb/audio-continue.rst similarity index 72% rename from Documentation/media/uapi/dvb/audio-clear-buffer.rst rename to Documentation/userspace-api/media/dvb/audio-continue.rst index c5b62cde18c8..b9a2b1e608b6 100644 --- a/Documentation/media/uapi/dvb/audio-clear-buffer.rst +++ b/Documentation/userspace-api/media/dvb/audio-continue.rst @@ -3,28 +3,29 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_CLEAR_BUFFER: +.. _AUDIO_CONTINUE: -================== -AUDIO_CLEAR_BUFFER -================== +============== +AUDIO_CONTINUE +============== Name ---- -AUDIO_CLEAR_BUFFER +AUDIO_CONTINUE .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_CLEAR_BUFFER) - :name: AUDIO_CLEAR_BUFFER +.. c:function:: int ioctl(int fd, AUDIO_CONTINUE) + :name: AUDIO_CONTINUE + Arguments --------- @@ -43,8 +44,8 @@ Arguments Description ----------- -This ioctl call asks the Audio Device to clear all software and hardware -buffers of the audio decoder device. +This ioctl restarts the decoding and playing process previously paused +with AUDIO_PAUSE command. Return Value diff --git a/Documentation/media/uapi/dvb/audio-set-mixer.rst b/Documentation/userspace-api/media/dvb/audio-fclose.rst similarity index 55% rename from Documentation/media/uapi/dvb/audio-set-mixer.rst rename to Documentation/userspace-api/media/dvb/audio-fclose.rst index 60781aa88202..448471d2f570 100644 --- a/Documentation/media/uapi/dvb/audio-set-mixer.rst +++ b/Documentation/userspace-api/media/dvb/audio-fclose.rst @@ -3,28 +3,29 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_SET_MIXER: +.. _audio_fclose: -=============== -AUDIO_SET_MIXER -=============== +======================== +Digital TV audio close() +======================== Name ---- -AUDIO_SET_MIXER +Digital TV audio close() .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, struct audio_mixer *mix) - :name: AUDIO_SET_MIXER +.. c:function:: int close(int fd) + :name: dvb-audio-close + Arguments --------- @@ -34,28 +35,29 @@ Arguments :stub-columns: 0 - - + - .. row 1 - int fd - File descriptor returned by a previous call to open(). - - - - - audio_mixer_t \*mix - - - mixer settings. - Description ----------- -This ioctl lets you adjust the mixer settings of the audio decoder. +This system call closes a previously opened 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 ` chapter. +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + + - .. row 1 + + - ``EBADF`` + + - fd is not a valid open file descriptor. diff --git a/Documentation/media/uapi/dvb/video-fopen.rst b/Documentation/userspace-api/media/dvb/audio-fopen.rst similarity index 53% rename from Documentation/media/uapi/dvb/video-fopen.rst rename to Documentation/userspace-api/media/dvb/audio-fopen.rst index 7b2a8c750e6a..f7ae94378f92 100644 --- a/Documentation/media/uapi/dvb/video-fopen.rst +++ b/Documentation/userspace-api/media/dvb/audio-fopen.rst @@ -3,27 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _video_fopen: +.. _audio_fopen: -================ -dvb video open() -================ +======================= +Digital TV audio open() +======================= Name ---- -dvb video open() +Digital TV audio open() -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- .. c:function:: int open(const char *deviceName, int flags) + :name: dvb-audio-open Arguments @@ -38,7 +39,7 @@ Arguments - const char \*deviceName - - Name of specific video device. + - Name of specific audio device. - .. row 2 @@ -70,21 +71,19 @@ Arguments Description ----------- -This system call opens a named video device (e.g. -/dev/dvb/adapter0/video0) for subsequent use. - -When an open() call has succeeded, the device will be ready for use. The -significance of blocking or non-blocking mode is described in the -documentation for functions where there is a difference. It does not -affect the semantics of the open() call itself. A device opened in -blocking mode can later be put into non-blocking mode (and vice versa) -using the F_SETFL command of the fcntl system call. This is a standard -system call, documented in the Linux manual page for fcntl. Only one -user can open the Video Device in O_RDWR mode. All other attempts to -open the device in this mode will fail, and an error-code will be -returned. If the Video Device is opened in O_RDONLY mode, the only -ioctl call that can be used is VIDEO_GET_STATUS. All other call will -return an error code. +This system call opens a named audio device (e.g. +/dev/dvb/adapter0/audio0) for subsequent use. When an open() call has +succeeded, the device will be ready for use. The significance of +blocking or non-blocking mode is described in the documentation for +functions where there is a difference. It does not affect the semantics +of the open() call itself. A device opened in blocking mode can later be +put into non-blocking mode (and vice versa) using the F_SETFL command +of the fcntl system call. This is a standard system call, documented in +the Linux manual page for fcntl. Only one user can open the Audio Device +in O_RDWR mode. All other attempts to open the device in this mode will +fail, and an error code will be returned. If the Audio Device is opened +in O_RDONLY mode, the only ioctl call that can be used is +AUDIO_GET_STATUS. All other call will return with an error code. Return Value @@ -105,17 +104,11 @@ Return Value - .. row 2 - - ``EINTERNAL`` - - - Internal error. - - - .. row 3 - - ``EBUSY`` - Device or resource busy. - - .. row 4 + - .. row 3 - ``EINVAL`` diff --git a/Documentation/media/uapi/dvb/audio-fwrite.rst b/Documentation/userspace-api/media/dvb/audio-fwrite.rst similarity index 96% rename from Documentation/media/uapi/dvb/audio-fwrite.rst rename to Documentation/userspace-api/media/dvb/audio-fwrite.rst index 6dc6bf6cbbc7..1482636f9b1a 100644 --- a/Documentation/media/uapi/dvb/audio-fwrite.rst +++ b/Documentation/userspace-api/media/dvb/audio-fwrite.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/audio-continue.rst b/Documentation/userspace-api/media/dvb/audio-get-capabilities.rst similarity index 63% rename from Documentation/media/uapi/dvb/audio-continue.rst rename to Documentation/userspace-api/media/dvb/audio-get-capabilities.rst index 6bdc99e39e20..4e70d82969ad 100644 --- a/Documentation/media/uapi/dvb/audio-continue.rst +++ b/Documentation/userspace-api/media/dvb/audio-get-capabilities.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_CONTINUE: +.. _AUDIO_GET_CAPABILITIES: -============== -AUDIO_CONTINUE -============== +====================== +AUDIO_GET_CAPABILITIES +====================== Name ---- -AUDIO_CONTINUE +AUDIO_GET_CAPABILITIES .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_CONTINUE) - :name: AUDIO_CONTINUE +.. c:function:: int ioctl(int fd, AUDIO_GET_CAPABILITIES, unsigned int *cap) + :name: AUDIO_GET_CAPABILITIES Arguments @@ -35,17 +35,24 @@ Arguments :stub-columns: 0 - - .. row 1 + - - int fd - File descriptor returned by a previous call to open(). + - + + - unsigned int \*cap + + - Returns a bit array of supported sound formats. + + Description ----------- -This ioctl restarts the decoding and playing process previously paused -with AUDIO_PAUSE command. +This ioctl call asks the Audio Device to tell us about the decoding +capabilities of the audio hardware. Return Value diff --git a/Documentation/media/uapi/dvb/video-set-blank.rst b/Documentation/userspace-api/media/dvb/audio-get-status.rst similarity index 59% rename from Documentation/media/uapi/dvb/video-set-blank.rst rename to Documentation/userspace-api/media/dvb/audio-get-status.rst index 901c3c80f167..5a5180d642d4 100644 --- a/Documentation/media/uapi/dvb/video-set-blank.rst +++ b/Documentation/userspace-api/media/dvb/audio-get-status.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_SET_BLANK: +.. _AUDIO_GET_STATUS: -=============== -VIDEO_SET_BLANK -=============== +================ +AUDIO_GET_STATUS +================ Name ---- -VIDEO_SET_BLANK +AUDIO_GET_STATUS -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_SET_BLANK, boolean mode) - :name: VIDEO_SET_BLANK +.. c:function:: int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status) + :name: AUDIO_GET_STATUS Arguments @@ -35,34 +35,24 @@ Arguments :stub-columns: 0 - - .. row 1 + - - int fd - File descriptor returned by a previous call to open(). - - .. row 2 + - - - int request + - struct audio_status \*status - - Equals VIDEO_SET_BLANK for this command. - - - .. row 3 - - - boolean mode - - - TRUE: Blank screen when stop. - - - .. row 4 - - - - - FALSE: Show last decoded frame. + - Returns the current state of Audio Device. Description ----------- -This ioctl call asks the Video Device to blank out the picture. +This ioctl call asks the Audio Device to return the current state of the +Audio Device. Return Value diff --git a/Documentation/media/uapi/dvb/video-stillpicture.rst b/Documentation/userspace-api/media/dvb/audio-pause.rst similarity index 54% rename from Documentation/media/uapi/dvb/video-stillpicture.rst rename to Documentation/userspace-api/media/dvb/audio-pause.rst index 58035a7630e6..3e9fe06d3a0f 100644 --- a/Documentation/media/uapi/dvb/video-stillpicture.rst +++ b/Documentation/userspace-api/media/dvb/audio-pause.rst @@ -3,29 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_STILLPICTURE: +.. _AUDIO_PAUSE: -================== -VIDEO_STILLPICTURE -================== +=========== +AUDIO_PAUSE +=========== Name ---- -VIDEO_STILLPICTURE +AUDIO_PAUSE -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_STILLPICTURE, struct video_still_picture *sp) - :name: VIDEO_STILLPICTURE - +.. c:function:: int ioctl(int fd, AUDIO_PAUSE) + :name: AUDIO_PAUSE Arguments --------- @@ -41,25 +40,13 @@ Arguments - File descriptor returned by a previous call to open(). - - .. row 2 - - - int request - - - Equals VIDEO_STILLPICTURE for this command. - - - .. row 3 - - - struct video_still_picture \*sp - - - Pointer to a location where an I-frame and size is stored. - Description ----------- -This ioctl call asks the Video Device to display a still picture -(I-frame). The input data shall contain an I-frame. If the pointer is -NULL, then the current displayed still picture is blanked. +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 diff --git a/Documentation/media/uapi/dvb/audio-pause.rst b/Documentation/userspace-api/media/dvb/audio-play.rst similarity index 69% rename from Documentation/media/uapi/dvb/audio-pause.rst rename to Documentation/userspace-api/media/dvb/audio-play.rst index 4567ecd9e0a3..388a581a19f2 100644 --- a/Documentation/media/uapi/dvb/audio-pause.rst +++ b/Documentation/userspace-api/media/dvb/audio-play.rst @@ -3,28 +3,29 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_PAUSE: +.. _AUDIO_PLAY: -=========== -AUDIO_PAUSE -=========== +========== +AUDIO_PLAY +========== Name ---- -AUDIO_PAUSE +AUDIO_PLAY .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_PAUSE) - :name: AUDIO_PAUSE +.. c:function:: int ioctl(int fd, AUDIO_PLAY) + :name: AUDIO_PLAY + Arguments --------- @@ -40,13 +41,11 @@ Arguments - File descriptor returned by a previous call to open(). - 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. +This ioctl call asks the Audio Device to start playing an audio stream +from the selected source. Return Value diff --git a/Documentation/media/uapi/dvb/audio-get-status.rst b/Documentation/userspace-api/media/dvb/audio-select-source.rst similarity index 58% rename from Documentation/media/uapi/dvb/audio-get-status.rst rename to Documentation/userspace-api/media/dvb/audio-select-source.rst index 30e4dd7fce6d..1ce64507de93 100644 --- a/Documentation/media/uapi/dvb/audio-get-status.rst +++ b/Documentation/userspace-api/media/dvb/audio-select-source.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_GET_STATUS: +.. _AUDIO_SELECT_SOURCE: -================ -AUDIO_GET_STATUS -================ +=================== +AUDIO_SELECT_SOURCE +=================== Name ---- -AUDIO_GET_STATUS +AUDIO_SELECT_SOURCE .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_GET_STATUS, struct audio_status *status) - :name: AUDIO_GET_STATUS +.. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, struct audio_stream_source *source) + :name: AUDIO_SELECT_SOURCE Arguments @@ -43,16 +43,18 @@ Arguments - - - struct audio_status \*status + - audio_stream_source_t source - - Returns the current state of Audio Device. + - Indicates the source that shall be used for the Audio stream. Description ----------- -This ioctl call asks the Audio Device to return the current state of the -Audio Device. +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 diff --git a/Documentation/media/uapi/dvb/audio-get-capabilities.rst b/Documentation/userspace-api/media/dvb/audio-set-av-sync.rst similarity index 64% rename from Documentation/media/uapi/dvb/audio-get-capabilities.rst rename to Documentation/userspace-api/media/dvb/audio-set-av-sync.rst index 4f1ec47e8ac2..3a0400dcfae4 100644 --- a/Documentation/media/uapi/dvb/audio-get-capabilities.rst +++ b/Documentation/userspace-api/media/dvb/audio-set-av-sync.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_GET_CAPABILITIES: +.. _AUDIO_SET_AV_SYNC: -====================== -AUDIO_GET_CAPABILITIES -====================== +================= +AUDIO_SET_AV_SYNC +================= Name ---- -AUDIO_GET_CAPABILITIES +AUDIO_SET_AV_SYNC .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_GET_CAPABILITIES, unsigned int *cap) - :name: AUDIO_GET_CAPABILITIES +.. c:function:: int ioctl(int fd, AUDIO_SET_AV_SYNC, boolean state) + :name: AUDIO_SET_AV_SYNC Arguments @@ -43,16 +43,20 @@ Arguments - - - unsigned int \*cap + - boolean state - - Returns a bit array of supported sound formats. + - Tells the Digital TV subsystem if A/V synchronization shall be ON or OFF. + + TRUE: AV-sync ON + + FALSE: AV-sync OFF Description ----------- -This ioctl call asks the Audio Device to tell us about the decoding -capabilities of the audio hardware. +This ioctl call asks the Audio Device to turn ON or OFF A/V +synchronization. Return Value diff --git a/Documentation/media/uapi/dvb/audio-play.rst b/Documentation/userspace-api/media/dvb/audio-set-bypass-mode.rst similarity index 51% rename from Documentation/media/uapi/dvb/audio-play.rst rename to Documentation/userspace-api/media/dvb/audio-set-bypass-mode.rst index 17acd4c411b8..0d2f23cc2f16 100644 --- a/Documentation/media/uapi/dvb/audio-play.rst +++ b/Documentation/userspace-api/media/dvb/audio-set-bypass-mode.rst @@ -3,29 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_PLAY: +.. _AUDIO_SET_BYPASS_MODE: -========== -AUDIO_PLAY -========== +===================== +AUDIO_SET_BYPASS_MODE +===================== Name ---- -AUDIO_PLAY +AUDIO_SET_BYPASS_MODE .. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_PLAY) - :name: AUDIO_PLAY - +.. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode) + :name: AUDIO_SET_BYPASS_MODE Arguments --------- @@ -35,17 +34,32 @@ Arguments :stub-columns: 0 - - .. row 1 + - - int fd - File descriptor returned by a previous call to open(). + - + + - boolean mode + + - Enables or disables the decoding of the current Audio stream in + the Digital TV subsystem. + + TRUE: Bypass is disabled + + FALSE: Bypass is enabled + + Description ----------- -This ioctl call asks the Audio Device to start playing an audio stream -from the selected source. +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 Digital TV system shall be decoded. Dolby +DigitalTM streams are automatically forwarded by the Digital TV subsystem if +the hardware can handle it. Return Value diff --git a/Documentation/media/uapi/dvb/audio-set-id.rst b/Documentation/userspace-api/media/dvb/audio-set-id.rst similarity index 96% rename from Documentation/media/uapi/dvb/audio-set-id.rst rename to Documentation/userspace-api/media/dvb/audio-set-id.rst index aeb6ace6cd1e..83fc1217fda0 100644 --- a/Documentation/media/uapi/dvb/audio-set-id.rst +++ b/Documentation/userspace-api/media/dvb/audio-set-id.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/video-set-streamtype.rst b/Documentation/userspace-api/media/dvb/audio-set-mixer.rst similarity index 55% rename from Documentation/media/uapi/dvb/video-set-streamtype.rst rename to Documentation/userspace-api/media/dvb/audio-set-mixer.rst index 845486a6e049..52bfc3af79dc 100644 --- a/Documentation/media/uapi/dvb/video-set-streamtype.rst +++ b/Documentation/userspace-api/media/dvb/audio-set-mixer.rst @@ -3,29 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_SET_STREAMTYPE: +.. _AUDIO_SET_MIXER: -==================== -VIDEO_SET_STREAMTYPE -==================== +=============== +AUDIO_SET_MIXER +=============== Name ---- -VIDEO_SET_STREAMTYPE +AUDIO_SET_MIXER -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_SET_STREAMTYPE, int type) - :name: VIDEO_SET_STREAMTYPE - +.. c:function:: int ioctl(int fd, AUDIO_SET_MIXER, struct audio_mixer *mix) + :name: AUDIO_SET_MIXER Arguments --------- @@ -35,31 +34,23 @@ Arguments :stub-columns: 0 - - .. row 1 + - - int fd - File descriptor returned by a previous call to open(). - - .. row 2 - - - int request - - - Equals VIDEO_SET_STREAMTYPE for this command. - - - .. row 3 + - - - int type + - audio_mixer_t \*mix - - stream type + - mixer settings. Description ----------- -This ioctl tells the driver which kind of stream to expect being written -to it. If this call is not used the default of video PES is used. Some -drivers might not support this call and always expect PES. +This ioctl lets you adjust the mixer settings of the audio decoder. Return Value diff --git a/Documentation/media/uapi/dvb/video-stop.rst b/Documentation/userspace-api/media/dvb/audio-set-mute.rst similarity index 54% rename from Documentation/media/uapi/dvb/video-stop.rst rename to Documentation/userspace-api/media/dvb/audio-set-mute.rst index 732ace05e34b..8f3a8332cebc 100644 --- a/Documentation/media/uapi/dvb/video-stop.rst +++ b/Documentation/userspace-api/media/dvb/audio-set-mute.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_STOP: +.. _AUDIO_SET_MUTE: -========== -VIDEO_STOP -========== +============== +AUDIO_SET_MUTE +============== Name ---- -VIDEO_STOP +AUDIO_SET_MUTE -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode) - :name: VIDEO_STOP +.. c:function:: int ioctl(int fd, AUDIO_SET_MUTE, boolean state) + :name: AUDIO_SET_MUTE Arguments @@ -35,44 +35,32 @@ Arguments :stub-columns: 0 - - .. row 1 + - - int fd - File descriptor returned by a previous call to open(). - - .. row 2 + - - - int request + - boolean state - - Equals VIDEO_STOP for this command. + - Indicates if audio device shall mute or not. - - .. row 3 + TRUE: Audio Mute - - Boolean mode - - - Indicates how the screen shall be handled. - - - .. row 4 - - - - - TRUE: Blank screen when stop. - - - .. row 5 - - - - - FALSE: Show last decoded frame. + FALSE: Audio Un-mute Description ----------- This ioctl is for Digital TV devices only. To control a V4L2 decoder use the -V4L2 :ref:`VIDIOC_DECODER_CMD` instead. +V4L2 :ref:`VIDIOC_DECODER_CMD` with the +``V4L2_DEC_CMD_START_MUTE_AUDIO`` flag instead. -This ioctl call asks the Video Device to stop playing the current -stream. Depending on the input parameter, the screen can be blanked out -or displaying the last decoded frame. +This ioctl call asks the audio device to mute the stream that is +currently being played. Return Value diff --git a/Documentation/media/uapi/dvb/audio-set-streamtype.rst b/Documentation/userspace-api/media/dvb/audio-set-streamtype.rst similarity index 96% rename from Documentation/media/uapi/dvb/audio-set-streamtype.rst rename to Documentation/userspace-api/media/dvb/audio-set-streamtype.rst index d20c34fc7128..c22bd247f03d 100644 --- a/Documentation/media/uapi/dvb/audio-set-streamtype.rst +++ b/Documentation/userspace-api/media/dvb/audio-set-streamtype.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/video-fclose.rst b/Documentation/userspace-api/media/dvb/audio-stop.rst similarity index 58% rename from Documentation/media/uapi/dvb/video-fclose.rst rename to Documentation/userspace-api/media/dvb/audio-stop.rst index 3b0285b96a3c..291b6a42efac 100644 --- a/Documentation/media/uapi/dvb/video-fclose.rst +++ b/Documentation/userspace-api/media/dvb/audio-stop.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _video_fclose: +.. _AUDIO_STOP: -================= -dvb video close() -================= +========== +AUDIO_STOP +========== Name ---- -dvb video close() +AUDIO_STOP -.. attention:: This ioctl is deprecated. +.. attention:: This ioctl is deprecated Synopsis -------- -.. c:function:: int close(int fd) - +.. c:function:: int ioctl(int fd, AUDIO_STOP) + :name: AUDIO_STOP Arguments --------- @@ -44,19 +44,13 @@ Arguments Description ----------- -This system call closes a previously opened video device. +This ioctl call asks the Audio Device to stop playing the current +stream. Return Value ------------ -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - .. row 1 - - - ``EBADF`` - - - fd is not a valid open file descriptor. +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 ` chapter. diff --git a/Documentation/media/uapi/dvb/audio.rst b/Documentation/userspace-api/media/dvb/audio.rst similarity index 95% rename from Documentation/media/uapi/dvb/audio.rst rename to Documentation/userspace-api/media/dvb/audio.rst index ebc18fca76a4..e137c151335d 100644 --- a/Documentation/media/uapi/dvb/audio.rst +++ b/Documentation/userspace-api/media/dvb/audio.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/audio_data_types.rst b/Documentation/userspace-api/media/dvb/audio_data_types.rst similarity index 98% rename from Documentation/media/uapi/dvb/audio_data_types.rst rename to Documentation/userspace-api/media/dvb/audio_data_types.rst index 5b032fe13b9d..effe265b12d5 100644 --- a/Documentation/media/uapi/dvb/audio_data_types.rst +++ b/Documentation/userspace-api/media/dvb/audio_data_types.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/audio_function_calls.rst b/Documentation/userspace-api/media/dvb/audio_function_calls.rst similarity index 94% rename from Documentation/media/uapi/dvb/audio_function_calls.rst rename to Documentation/userspace-api/media/dvb/audio_function_calls.rst index 5478e78b085e..be90a828fe29 100644 --- a/Documentation/media/uapi/dvb/audio_function_calls.rst +++ b/Documentation/userspace-api/media/dvb/audio_function_calls.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-stop.rst b/Documentation/userspace-api/media/dvb/ca-fclose.rst similarity index 59% rename from Documentation/media/uapi/dvb/dmx-stop.rst rename to Documentation/userspace-api/media/dvb/ca-fclose.rst index 982384d12923..cedfb7ee6a01 100644 --- a/Documentation/media/uapi/dvb/dmx-stop.rst +++ b/Documentation/userspace-api/media/dvb/ca-fclose.rst @@ -3,41 +3,39 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _DMX_STOP: +.. _ca_fclose: -======== -DMX_STOP -======== +===================== +Digital TV CA close() +===================== Name ---- -DMX_STOP +Digital TV CA close() Synopsis -------- -.. c:function:: int ioctl( int fd, DMX_STOP) - :name: DMX_STOP +.. c:function:: int close(int fd) + :name: dvb-ca-close Arguments --------- ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by a previous call to :c:func:`open() `. Description ----------- -This ioctl call is used to stop the actual filtering operation defined -via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and -started via the :ref:`DMX_START` command. +This system call closes a previously opened CA device. Return Value @@ -48,5 +46,5 @@ On success 0 is returned. On error -1 is returned, and the ``errno`` variable is set appropriately. -The generic error codes are described at the +Generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/ca-fopen.rst b/Documentation/userspace-api/media/dvb/ca-fopen.rst similarity index 97% rename from Documentation/media/uapi/dvb/ca-fopen.rst rename to Documentation/userspace-api/media/dvb/ca-fopen.rst index e11ebeae5693..aa0fde1739a8 100644 --- a/Documentation/media/uapi/dvb/ca-fopen.rst +++ b/Documentation/userspace-api/media/dvb/ca-fopen.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/ca-get-descr-info.rst b/Documentation/userspace-api/media/dvb/ca-get-cap.rst similarity index 54% rename from Documentation/media/uapi/dvb/ca-get-descr-info.rst rename to Documentation/userspace-api/media/dvb/ca-get-cap.rst index 80ef43a339df..b808d0592371 100644 --- a/Documentation/media/uapi/dvb/ca-get-descr-info.rst +++ b/Documentation/userspace-api/media/dvb/ca-get-cap.rst @@ -3,27 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _CA_GET_DESCR_INFO: +.. _CA_GET_CAP: -================= -CA_GET_DESCR_INFO -================= +========== +CA_GET_CAP +========== Name ---- -CA_GET_DESCR_INFO +CA_GET_CAP Synopsis -------- -.. c:function:: int ioctl(fd, CA_GET_DESCR_INFO, struct ca_descr_info *desc) - :name: CA_GET_DESCR_INFO +.. c:function:: int ioctl(fd, CA_GET_CAP, struct ca_caps *caps) + :name: CA_GET_CAP + Arguments --------- @@ -31,19 +32,22 @@ Arguments ``fd`` File descriptor returned by a previous call to :c:func:`open() `. -``desc`` - Pointer to struct :c:type:`ca_descr_info`. +``caps`` + Pointer to struct :c:type:`ca_caps`. Description ----------- -Returns information about all descrambler slots. +Queries the Kernel for information about the available CA and descrambler +slots, and their types. Return Value ------------ -On success 0 is returned, and :c:type:`ca_descr_info` is filled. +On success 0 is returned and :c:type:`ca_caps` is filled. + +On error, -1 is returned and the ``errno`` variable is set +appropriately. -On error -1 is returned, and the ``errno`` variable is set -appropriately. The generic error codes are described at the +The generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/ca-reset.rst b/Documentation/userspace-api/media/dvb/ca-get-descr-info.rst similarity index 52% rename from Documentation/media/uapi/dvb/ca-reset.rst rename to Documentation/userspace-api/media/dvb/ca-get-descr-info.rst index 29fda19984be..396cc66a8243 100644 --- a/Documentation/media/uapi/dvb/ca-reset.rst +++ b/Documentation/userspace-api/media/dvb/ca-get-descr-info.rst @@ -3,49 +3,47 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _CA_RESET: +.. _CA_GET_DESCR_INFO: -======== -CA_RESET -======== +================= +CA_GET_DESCR_INFO +================= Name ---- -CA_RESET +CA_GET_DESCR_INFO Synopsis -------- -.. c:function:: int ioctl(fd, CA_RESET) - :name: CA_RESET - +.. c:function:: int ioctl(fd, CA_GET_DESCR_INFO, struct ca_descr_info *desc) + :name: CA_GET_DESCR_INFO Arguments --------- ``fd`` - File descriptor returned by a previous call to :c:func:`open() `. + File descriptor returned by a previous call to :c:func:`open() `. + +``desc`` + Pointer to struct :c:type:`ca_descr_info`. Description ----------- -Puts the Conditional Access hardware on its initial state. It should -be called before start using the CA hardware. - +Returns information about all descrambler slots. Return Value ------------ -On success 0 is returned. +On success 0 is returned, and :c:type:`ca_descr_info` is filled. On error -1 is returned, and the ``errno`` variable is set -appropriately. - -Generic error codes are described at the +appropriately. The generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst b/Documentation/userspace-api/media/dvb/ca-get-msg.rst similarity index 50% rename from Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst rename to Documentation/userspace-api/media/dvb/ca-get-msg.rst index 30a48114153c..995f461d6879 100644 --- a/Documentation/media/uapi/dvb/fe-diseqc-send-master-cmd.rst +++ b/Documentation/userspace-api/media/dvb/ca-get-msg.rst @@ -3,48 +3,52 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_DISEQC_SEND_MASTER_CMD: +.. _CA_GET_MSG: -******************************* -ioctl FE_DISEQC_SEND_MASTER_CMD -******************************* +========== +CA_GET_MSG +========== Name -==== +---- -FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command +CA_GET_MSG Synopsis -======== +-------- -.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp ) - :name: FE_DISEQC_SEND_MASTER_CMD +.. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg) + :name: CA_GET_MSG Arguments -========= +--------- ``fd`` - File descriptor returned by :ref:`open() `. - -``argp`` - pointer to struct - :c:type:`dvb_diseqc_master_cmd` + File descriptor returned by a previous call to :c:func:`open() `. +``msg`` + Pointer to struct :c:type:`ca_msg`. Description -=========== +----------- + +Receives a message via a CI CA module. + +.. note:: + + Please notice that, on most drivers, this is done by reading from + the /dev/adapter?/ca? device node. -Sends the DiSEqC command pointed by :c:type:`dvb_diseqc_master_cmd` -to the antenna subsystem. Return Value -============ +------------ + On success 0 is returned. @@ -53,4 +57,3 @@ appropriately. Generic error codes are described at the :ref:`Generic Error Codes ` chapter. - diff --git a/Documentation/media/uapi/dvb/net-remove-if.rst b/Documentation/userspace-api/media/dvb/ca-get-slot-info.rst similarity index 50% rename from Documentation/media/uapi/dvb/net-remove-if.rst rename to Documentation/userspace-api/media/dvb/ca-get-slot-info.rst index bf9a1602eeec..c65987ff9cb3 100644 --- a/Documentation/media/uapi/dvb/net-remove-if.rst +++ b/Documentation/userspace-api/media/dvb/ca-get-slot-info.rst @@ -3,53 +3,62 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _NET_REMOVE_IF: +.. _CA_GET_SLOT_INFO: -******************* -ioctl NET_REMOVE_IF -******************* +================ +CA_GET_SLOT_INFO +================ Name -==== +---- -NET_REMOVE_IF - Removes a network interface. +CA_GET_SLOT_INFO Synopsis -======== +-------- -.. c:function:: int ioctl( int fd, NET_REMOVE_IF, int ifnum ) - :name: NET_REMOVE_IF +.. c:function:: int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info) + :name: CA_GET_SLOT_INFO Arguments -========= +--------- ``fd`` - File descriptor returned by :ref:`open() `. - -``net_if`` - number of the interface to be removed + File descriptor returned by a previous call to :c:func:`open() `. +``info`` + Pointer to struct :c:type:`ca_slot_info`. Description -=========== +----------- -The NET_REMOVE_IF ioctl deletes an interface previously created via -:ref:`NET_ADD_IF `. +Returns information about a CA slot identified by +:c:type:`ca_slot_info`.slot_num. Return Value -============ +------------ On success 0 is returned, and :c:type:`ca_slot_info` is filled. On error -1 is returned, and the ``errno`` variable is set appropriately. +.. tabularcolumns:: |p{2.5cm}|p{15.0cm}| + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + :widths: 1 16 + + - - ``ENODEV`` + - the slot is not available. + The generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/dmx-fclose.rst b/Documentation/userspace-api/media/dvb/ca-reset.rst similarity index 53% rename from Documentation/media/uapi/dvb/dmx-fclose.rst rename to Documentation/userspace-api/media/dvb/ca-reset.rst index 05ff32270274..116a5a8eeb5d 100644 --- a/Documentation/media/uapi/dvb/dmx-fclose.rst +++ b/Documentation/userspace-api/media/dvb/ca-reset.rst @@ -3,41 +3,40 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _dmx_fclose: +.. _CA_RESET: -======================== -Digital TV demux close() -======================== +======== +CA_RESET +======== Name ---- -Digital TV demux close() +CA_RESET Synopsis -------- -.. c:function:: int close(int fd) - :name: dvb-dmx-close +.. c:function:: int ioctl(fd, CA_RESET) + :name: CA_RESET Arguments --------- ``fd`` - File descriptor returned by a previous call to - :c:func:`open() `. + File descriptor returned by a previous call to :c:func:`open() `. Description ----------- -This system call deactivates and deallocates a filter that was -previously allocated via the :c:func:`open() ` call. +Puts the Conditional Access hardware on its initial state. It should +be called before start using the CA hardware. Return Value @@ -45,8 +44,8 @@ Return Value On success 0 is returned. -On error, -1 is returned and the ``errno`` variable is set +On error -1 is returned, and the ``errno`` variable is set appropriately. -The generic error codes are described at the +Generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/dmx-set-buffer-size.rst b/Documentation/userspace-api/media/dvb/ca-send-msg.rst similarity index 51% rename from Documentation/media/uapi/dvb/dmx-set-buffer-size.rst rename to Documentation/userspace-api/media/dvb/ca-send-msg.rst index 2dee0fb11f62..716d88e0fdc5 100644 --- a/Documentation/media/uapi/dvb/dmx-set-buffer-size.rst +++ b/Documentation/userspace-api/media/dvb/ca-send-msg.rst @@ -3,55 +3,56 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _DMX_SET_BUFFER_SIZE: +.. _CA_SEND_MSG: -=================== -DMX_SET_BUFFER_SIZE -=================== +=========== +CA_SEND_MSG +=========== Name ---- -DMX_SET_BUFFER_SIZE +CA_SEND_MSG Synopsis -------- -.. c:function:: int ioctl( int fd, DMX_SET_BUFFER_SIZE, unsigned long size) - :name: DMX_SET_BUFFER_SIZE +.. c:function:: int ioctl(fd, CA_SEND_MSG, struct ca_msg *msg) + :name: CA_SEND_MSG Arguments --------- ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by a previous call to :c:func:`open() `. + +``msg`` + Pointer to struct :c:type:`ca_msg`. -``size`` - Unsigned long size Description ----------- -This ioctl call is used to set the size of the circular buffer used for -filtered data. The default size is two maximum sized sections, i.e. if -this function is not called a buffer size of ``2 * 4096`` bytes will be -used. +Sends a message via a CI CA module. + +.. note:: + Please notice that, on most drivers, this is done by writing + to the /dev/adapter?/ca? device node. Return Value ------------ - On success 0 is returned. On error -1 is returned, and the ``errno`` variable is set appropriately. -The generic error codes are described at the +Generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/ca-get-slot-info.rst b/Documentation/userspace-api/media/dvb/ca-set-descr.rst similarity index 52% rename from Documentation/media/uapi/dvb/ca-get-slot-info.rst rename to Documentation/userspace-api/media/dvb/ca-set-descr.rst index 1ea5c497f2ea..2c57371675e2 100644 --- a/Documentation/media/uapi/dvb/ca-get-slot-info.rst +++ b/Documentation/userspace-api/media/dvb/ca-set-descr.rst @@ -3,27 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _CA_GET_SLOT_INFO: +.. _CA_SET_DESCR: -================ -CA_GET_SLOT_INFO -================ +============ +CA_SET_DESCR +============ Name ---- -CA_GET_SLOT_INFO +CA_SET_DESCR Synopsis -------- -.. c:function:: int ioctl(fd, CA_GET_SLOT_INFO, struct ca_slot_info *info) - :name: CA_GET_SLOT_INFO +.. c:function:: int ioctl(fd, CA_SET_DESCR, struct ca_descr *desc) + :name: CA_SET_DESCR Arguments @@ -32,33 +32,22 @@ Arguments ``fd`` File descriptor returned by a previous call to :c:func:`open() `. -``info`` - Pointer to struct :c:type:`ca_slot_info`. +``msg`` + Pointer to struct :c:type:`ca_descr`. Description ----------- -Returns information about a CA slot identified by -:c:type:`ca_slot_info`.slot_num. - +CA_SET_DESCR is used for feeding descrambler CA slots with descrambling +keys (referred as control words). Return Value ------------ -On success 0 is returned, and :c:type:`ca_slot_info` is filled. +On success 0 is returned. On error -1 is returned, and the ``errno`` variable is set appropriately. -.. tabularcolumns:: |p{2.5cm}|p{15.0cm}| - -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - :widths: 1 16 - - - - ``ENODEV`` - - the slot is not available. - -The generic error codes are described at the +Generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/ca.rst b/Documentation/userspace-api/media/dvb/ca.rst similarity index 94% rename from Documentation/media/uapi/dvb/ca.rst rename to Documentation/userspace-api/media/dvb/ca.rst index c6ee624b1234..643b7c414943 100644 --- a/Documentation/media/uapi/dvb/ca.rst +++ b/Documentation/userspace-api/media/dvb/ca.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/capture-example.rst b/Documentation/userspace-api/media/dvb/ca_data_types.rst similarity index 69% rename from Documentation/media/uapi/v4l/capture-example.rst rename to Documentation/userspace-api/media/dvb/ca_data_types.rst index 130ca47ef796..20e2b552144f 100644 --- a/Documentation/media/uapi/v4l/capture-example.rst +++ b/Documentation/userspace-api/media/dvb/ca_data_types.rst @@ -3,18 +3,14 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _capture-example: +.. _ca_data_types: -********************* -Video Capture Example -********************* +************* +CA Data Types +************* - -.. toctree:: - :maxdepth: 1 - - capture.c +.. kernel-doc:: include/uapi/linux/dvb/ca.h diff --git a/Documentation/media/uapi/rc/lirc-header.rst b/Documentation/userspace-api/media/dvb/ca_function_calls.rst similarity index 56% rename from Documentation/media/uapi/rc/lirc-header.rst rename to Documentation/userspace-api/media/dvb/ca_function_calls.rst index c9b4f33e1031..b8aceb1895b6 100644 --- a/Documentation/media/uapi/rc/lirc-header.rst +++ b/Documentation/userspace-api/media/dvb/ca_function_calls.rst @@ -3,15 +3,25 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _lirc_header: +.. _ca_function_calls: -**************** -LIRC Header File -**************** +***************** +CA Function Calls +***************** -.. kernel-include:: $BUILDDIR/lirc.h.rst +.. toctree:: + :maxdepth: 1 + ca-fopen + ca-fclose + ca-reset + ca-get-cap + ca-get-slot-info + ca-get-descr-info + ca-get-msg + ca-send-msg + ca-set-descr diff --git a/Documentation/media/uapi/dvb/ca_high_level.rst b/Documentation/userspace-api/media/dvb/ca_high_level.rst similarity index 100% rename from Documentation/media/uapi/dvb/ca_high_level.rst rename to Documentation/userspace-api/media/dvb/ca_high_level.rst diff --git a/Documentation/media/uapi/dvb/demux.rst b/Documentation/userspace-api/media/dvb/demux.rst similarity index 94% rename from Documentation/media/uapi/dvb/demux.rst rename to Documentation/userspace-api/media/dvb/demux.rst index d8c0ff4015fe..00397b075e0f 100644 --- a/Documentation/media/uapi/dvb/demux.rst +++ b/Documentation/userspace-api/media/dvb/demux.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/ca-set-descr.rst b/Documentation/userspace-api/media/dvb/dmx-add-pid.rst similarity index 59% rename from Documentation/media/uapi/dvb/ca-set-descr.rst rename to Documentation/userspace-api/media/dvb/dmx-add-pid.rst index d36464ba2317..e309cd56fdf0 100644 --- a/Documentation/media/uapi/dvb/ca-set-descr.rst +++ b/Documentation/userspace-api/media/dvb/dmx-add-pid.rst @@ -3,43 +3,46 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _CA_SET_DESCR: +.. _DMX_ADD_PID: -============ -CA_SET_DESCR -============ +=========== +DMX_ADD_PID +=========== Name ---- -CA_SET_DESCR +DMX_ADD_PID Synopsis -------- -.. c:function:: int ioctl(fd, CA_SET_DESCR, struct ca_descr *desc) - :name: CA_SET_DESCR +.. c:function:: int ioctl(fd, DMX_ADD_PID, __u16 *pid) + :name: DMX_ADD_PID Arguments --------- ``fd`` - File descriptor returned by a previous call to :c:func:`open() `. + File descriptor returned by :c:func:`open() `. + +``pid`` + PID number to be filtered. -``msg`` - Pointer to struct :c:type:`ca_descr`. Description ----------- -CA_SET_DESCR is used for feeding descrambler CA slots with descrambling -keys (referred as control words). +This ioctl call allows to add multiple PIDs to a transport stream filter +previously set up with :ref:`DMX_SET_PES_FILTER` and output equal to +:c:type:`DMX_OUT_TSDEMUX_TAP `. + Return Value ------------ diff --git a/Documentation/media/uapi/dvb/dmx-expbuf.rst b/Documentation/userspace-api/media/dvb/dmx-expbuf.rst similarity index 97% rename from Documentation/media/uapi/dvb/dmx-expbuf.rst rename to Documentation/userspace-api/media/dvb/dmx-expbuf.rst index d7f0658f3db3..f76db8ce3cfa 100644 --- a/Documentation/media/uapi/dvb/dmx-expbuf.rst +++ b/Documentation/userspace-api/media/dvb/dmx-expbuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/ca-get-cap.rst b/Documentation/userspace-api/media/dvb/dmx-fclose.rst similarity index 58% rename from Documentation/media/uapi/dvb/ca-get-cap.rst rename to Documentation/userspace-api/media/dvb/dmx-fclose.rst index 9e4fb5186373..e93bc60da508 100644 --- a/Documentation/media/uapi/dvb/ca-get-cap.rst +++ b/Documentation/userspace-api/media/dvb/dmx-fclose.rst @@ -3,48 +3,47 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _CA_GET_CAP: +.. _dmx_fclose: -========== -CA_GET_CAP -========== +======================== +Digital TV demux close() +======================== Name ---- -CA_GET_CAP +Digital TV demux close() Synopsis -------- -.. c:function:: int ioctl(fd, CA_GET_CAP, struct ca_caps *caps) - :name: CA_GET_CAP +.. c:function:: int close(int fd) + :name: dvb-dmx-close Arguments --------- ``fd`` - File descriptor returned by a previous call to :c:func:`open() `. - -``caps`` - Pointer to struct :c:type:`ca_caps`. + File descriptor returned by a previous call to + :c:func:`open() `. Description ----------- -Queries the Kernel for information about the available CA and descrambler -slots, and their types. +This system call deactivates and deallocates a filter that was +previously allocated via the :c:func:`open() ` call. + Return Value ------------ -On success 0 is returned and :c:type:`ca_caps` is filled. +On success 0 is returned. On error, -1 is returned and the ``errno`` variable is set appropriately. diff --git a/Documentation/media/uapi/dvb/dmx-fopen.rst b/Documentation/userspace-api/media/dvb/dmx-fopen.rst similarity index 97% rename from Documentation/media/uapi/dvb/dmx-fopen.rst rename to Documentation/userspace-api/media/dvb/dmx-fopen.rst index 2700a2fad68b..ea988714558e 100644 --- a/Documentation/media/uapi/dvb/dmx-fopen.rst +++ b/Documentation/userspace-api/media/dvb/dmx-fopen.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-fread.rst b/Documentation/userspace-api/media/dvb/dmx-fread.rst similarity index 97% rename from Documentation/media/uapi/dvb/dmx-fread.rst rename to Documentation/userspace-api/media/dvb/dmx-fread.rst index 292fa98f39ff..25501be818f8 100644 --- a/Documentation/media/uapi/dvb/dmx-fread.rst +++ b/Documentation/userspace-api/media/dvb/dmx-fread.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-fwrite.rst b/Documentation/userspace-api/media/dvb/dmx-fwrite.rst similarity index 97% rename from Documentation/media/uapi/dvb/dmx-fwrite.rst rename to Documentation/userspace-api/media/dvb/dmx-fwrite.rst index bdd4d4743bd5..4400f4ef8c65 100644 --- a/Documentation/media/uapi/dvb/dmx-fwrite.rst +++ b/Documentation/userspace-api/media/dvb/dmx-fwrite.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst b/Documentation/userspace-api/media/dvb/dmx-get-pes-pids.rst similarity index 96% rename from Documentation/media/uapi/dvb/dmx-get-pes-pids.rst rename to Documentation/userspace-api/media/dvb/dmx-get-pes-pids.rst index fcd3dc06c095..e1873e3fdc01 100644 --- a/Documentation/media/uapi/dvb/dmx-get-pes-pids.rst +++ b/Documentation/userspace-api/media/dvb/dmx-get-pes-pids.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-get-stc.rst b/Documentation/userspace-api/media/dvb/dmx-get-stc.rst similarity index 96% rename from Documentation/media/uapi/dvb/dmx-get-stc.rst rename to Documentation/userspace-api/media/dvb/dmx-get-stc.rst index 2c81595f470a..026a884edb0a 100644 --- a/Documentation/media/uapi/dvb/dmx-get-stc.rst +++ b/Documentation/userspace-api/media/dvb/dmx-get-stc.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-mmap.rst b/Documentation/userspace-api/media/dvb/dmx-mmap.rst similarity index 98% rename from Documentation/media/uapi/dvb/dmx-mmap.rst rename to Documentation/userspace-api/media/dvb/dmx-mmap.rst index 34bb7766718f..828ba9df73e2 100644 --- a/Documentation/media/uapi/dvb/dmx-mmap.rst +++ b/Documentation/userspace-api/media/dvb/dmx-mmap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-munmap.rst b/Documentation/userspace-api/media/dvb/dmx-munmap.rst similarity index 96% rename from Documentation/media/uapi/dvb/dmx-munmap.rst rename to Documentation/userspace-api/media/dvb/dmx-munmap.rst index ef26b6f2b12b..905fdd585a86 100644 --- a/Documentation/media/uapi/dvb/dmx-munmap.rst +++ b/Documentation/userspace-api/media/dvb/dmx-munmap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-qbuf.rst b/Documentation/userspace-api/media/dvb/dmx-qbuf.rst similarity index 98% rename from Documentation/media/uapi/dvb/dmx-qbuf.rst rename to Documentation/userspace-api/media/dvb/dmx-qbuf.rst index 9dc845daa59d..2c4657c2c86d 100644 --- a/Documentation/media/uapi/dvb/dmx-qbuf.rst +++ b/Documentation/userspace-api/media/dvb/dmx-qbuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-querybuf.rst b/Documentation/userspace-api/media/dvb/dmx-querybuf.rst similarity index 97% rename from Documentation/media/uapi/dvb/dmx-querybuf.rst rename to Documentation/userspace-api/media/dvb/dmx-querybuf.rst index 4cf36e821696..6e234daf1c44 100644 --- a/Documentation/media/uapi/dvb/dmx-querybuf.rst +++ b/Documentation/userspace-api/media/dvb/dmx-querybuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-remove-pid.rst b/Documentation/userspace-api/media/dvb/dmx-remove-pid.rst similarity index 95% rename from Documentation/media/uapi/dvb/dmx-remove-pid.rst rename to Documentation/userspace-api/media/dvb/dmx-remove-pid.rst index be992f44f306..dee553a48b63 100644 --- a/Documentation/media/uapi/dvb/dmx-remove-pid.rst +++ b/Documentation/userspace-api/media/dvb/dmx-remove-pid.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-reqbufs.rst b/Documentation/userspace-api/media/dvb/dmx-reqbufs.rst similarity index 98% rename from Documentation/media/uapi/dvb/dmx-reqbufs.rst rename to Documentation/userspace-api/media/dvb/dmx-reqbufs.rst index b302785bf678..9b9be45d2b0b 100644 --- a/Documentation/media/uapi/dvb/dmx-reqbufs.rst +++ b/Documentation/userspace-api/media/dvb/dmx-reqbufs.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/ca-send-msg.rst b/Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst similarity index 51% rename from Documentation/media/uapi/dvb/ca-send-msg.rst rename to Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst index 5a3c4e8120c4..7c91da1da4be 100644 --- a/Documentation/media/uapi/dvb/ca-send-msg.rst +++ b/Documentation/userspace-api/media/dvb/dmx-set-buffer-size.rst @@ -3,56 +3,55 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _CA_SEND_MSG: +.. _DMX_SET_BUFFER_SIZE: -=========== -CA_SEND_MSG -=========== +=================== +DMX_SET_BUFFER_SIZE +=================== Name ---- -CA_SEND_MSG +DMX_SET_BUFFER_SIZE Synopsis -------- -.. c:function:: int ioctl(fd, CA_SEND_MSG, struct ca_msg *msg) - :name: CA_SEND_MSG +.. c:function:: int ioctl( int fd, DMX_SET_BUFFER_SIZE, unsigned long size) + :name: DMX_SET_BUFFER_SIZE Arguments --------- ``fd`` - File descriptor returned by a previous call to :c:func:`open() `. - -``msg`` - Pointer to struct :c:type:`ca_msg`. + File descriptor returned by :c:func:`open() `. +``size`` + Unsigned long size Description ----------- -Sends a message via a CI CA module. - -.. note:: +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. - Please notice that, on most drivers, this is done by writing - to the /dev/adapter?/ca? device node. Return Value ------------ + On success 0 is returned. On error -1 is returned, and the ``errno`` variable is set appropriately. -Generic error codes are described at the +The generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/dmx-set-filter.rst b/Documentation/userspace-api/media/dvb/dmx-set-filter.rst similarity index 96% rename from Documentation/media/uapi/dvb/dmx-set-filter.rst rename to Documentation/userspace-api/media/dvb/dmx-set-filter.rst index 66afbb9f2fe4..cb3333349bd0 100644 --- a/Documentation/media/uapi/dvb/dmx-set-filter.rst +++ b/Documentation/userspace-api/media/dvb/dmx-set-filter.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-start.rst b/Documentation/userspace-api/media/dvb/dmx-set-pes-filter.rst similarity index 65% rename from Documentation/media/uapi/dvb/dmx-start.rst rename to Documentation/userspace-api/media/dvb/dmx-set-pes-filter.rst index 488289d02504..26da56947652 100644 --- a/Documentation/media/uapi/dvb/dmx-start.rst +++ b/Documentation/userspace-api/media/dvb/dmx-set-pes-filter.rst @@ -3,40 +3,47 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _DMX_START: +.. _DMX_SET_PES_FILTER: -========= -DMX_START -========= +================== +DMX_SET_PES_FILTER +================== Name ---- -DMX_START +DMX_SET_PES_FILTER Synopsis -------- -.. c:function:: int ioctl( int fd, DMX_START) - :name: DMX_START +.. c:function:: int ioctl( int fd, DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params) + :name: DMX_SET_PES_FILTER Arguments --------- + ``fd`` File descriptor returned by :c:func:`open() `. +``params`` + Pointer to structure containing filter parameters. + + Description ----------- -This ioctl call is used to start the actual filtering operation defined -via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`. +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 @@ -52,17 +59,11 @@ appropriately. .. flat-table:: :header-rows: 0 :stub-columns: 0 + :widths: 1 16 - .. row 1 - - ``EINVAL`` - - - Invalid argument, i.e. no filtering parameters provided via the - :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` ioctls. - - - .. row 2 - - ``EBUSY`` - This error code indicates that there are conflicting requests. diff --git a/Documentation/media/uapi/dvb/dmx-set-pes-filter.rst b/Documentation/userspace-api/media/dvb/dmx-start.rst similarity index 66% rename from Documentation/media/uapi/dvb/dmx-set-pes-filter.rst rename to Documentation/userspace-api/media/dvb/dmx-start.rst index dae5ab7878e5..a1d35f01fc95 100644 --- a/Documentation/media/uapi/dvb/dmx-set-pes-filter.rst +++ b/Documentation/userspace-api/media/dvb/dmx-start.rst @@ -3,47 +3,40 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _DMX_SET_PES_FILTER: +.. _DMX_START: -================== -DMX_SET_PES_FILTER -================== +========= +DMX_START +========= Name ---- -DMX_SET_PES_FILTER +DMX_START Synopsis -------- -.. c:function:: int ioctl( int fd, DMX_SET_PES_FILTER, struct dmx_pes_filter_params *params) - :name: DMX_SET_PES_FILTER +.. c:function:: int ioctl( int fd, DMX_START) + :name: DMX_START Arguments --------- - ``fd`` File descriptor returned by :c:func:`open() `. -``params`` - Pointer to structure containing filter parameters. - - 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. +This ioctl call is used to start the actual filtering operation defined +via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER`. Return Value @@ -59,11 +52,17 @@ appropriately. .. flat-table:: :header-rows: 0 :stub-columns: 0 - :widths: 1 16 - .. row 1 + - ``EINVAL`` + + - Invalid argument, i.e. no filtering parameters provided via the + :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` ioctls. + + - .. row 2 + - ``EBUSY`` - This error code indicates that there are conflicting requests. diff --git a/Documentation/media/uapi/dvb/fe-read-snr.rst b/Documentation/userspace-api/media/dvb/dmx-stop.rst similarity index 50% rename from Documentation/media/uapi/dvb/fe-read-snr.rst rename to Documentation/userspace-api/media/dvb/dmx-stop.rst index 2a7a0d8f1fd5..5e6e805010d0 100644 --- a/Documentation/media/uapi/dvb/fe-read-snr.rst +++ b/Documentation/userspace-api/media/dvb/dmx-stop.rst @@ -3,55 +3,50 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_READ_SNR: +.. _DMX_STOP: -*********** -FE_READ_SNR -*********** +======== +DMX_STOP +======== Name -==== +---- -FE_READ_SNR +DMX_STOP -.. attention:: This ioctl is deprecated. Synopsis -======== +-------- -.. c:function:: int ioctl(int fd, FE_READ_SNR, int16_t *snr) - :name: FE_READ_SNR +.. c:function:: int ioctl( int fd, DMX_STOP) + :name: DMX_STOP Arguments -========= +--------- ``fd`` - File descriptor returned by :c:func:`open() `. - -``snr`` - The signal-to-noise ratio is stored into \*snr. - + File descriptor returned by :c:func:`open() `. 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. +This ioctl call is used to stop the actual filtering operation defined +via the ioctl calls :ref:`DMX_SET_FILTER` or :ref:`DMX_SET_PES_FILTER` and +started via the :ref:`DMX_START` command. Return Value -============ +------------ On success 0 is returned. On error -1 is returned, and the ``errno`` variable is set appropriately. -Generic error codes are described at the +The generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/dmx_fcalls.rst b/Documentation/userspace-api/media/dvb/dmx_fcalls.rst similarity index 93% rename from Documentation/media/uapi/dvb/dmx_fcalls.rst rename to Documentation/userspace-api/media/dvb/dmx_fcalls.rst index 67312ab65f94..04e150f00f84 100644 --- a/Documentation/media/uapi/dvb/dmx_fcalls.rst +++ b/Documentation/userspace-api/media/dvb/dmx_fcalls.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend-header.rst b/Documentation/userspace-api/media/dvb/dmx_types.rst similarity index 70% rename from Documentation/media/uapi/dvb/frontend-header.rst rename to Documentation/userspace-api/media/dvb/dmx_types.rst index 635fb4251214..635b8fd363be 100644 --- a/Documentation/media/uapi/dvb/frontend-header.rst +++ b/Documentation/userspace-api/media/dvb/dmx_types.rst @@ -3,11 +3,14 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -Frontend uAPI data types -======================== +.. _dmx_types: -.. kernel-doc:: include/uapi/linux/dvb/frontend.h +**************** +Demux Data Types +**************** + +.. kernel-doc:: include/uapi/linux/dvb/dmx.h diff --git a/Documentation/media/uapi/dvb/dvb-fe-read-status.rst b/Documentation/userspace-api/media/dvb/dvb-fe-read-status.rst similarity index 95% rename from Documentation/media/uapi/dvb/dvb-fe-read-status.rst rename to Documentation/userspace-api/media/dvb/dvb-fe-read-status.rst index 172783b75fb7..5d6a7735a9d1 100644 --- a/Documentation/media/uapi/dvb/dvb-fe-read-status.rst +++ b/Documentation/userspace-api/media/dvb/dvb-fe-read-status.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/ca_data_types.rst b/Documentation/userspace-api/media/dvb/dvb-frontend-event.rst similarity index 60% rename from Documentation/media/uapi/dvb/ca_data_types.rst rename to Documentation/userspace-api/media/dvb/dvb-frontend-event.rst index 834c8ab4c300..7f5e56cf75cb 100644 --- a/Documentation/media/uapi/dvb/ca_data_types.rst +++ b/Documentation/userspace-api/media/dvb/dvb-frontend-event.rst @@ -3,14 +3,20 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _ca_data_types: +.. c:type:: dvb_frontend_event -************* -CA Data Types -************* +*************** +frontend events +*************** -.. kernel-doc:: include/uapi/linux/dvb/ca.h + +.. code-block:: c + + struct dvb_frontend_event { + fe_status_t status; + struct dvb_frontend_parameters parameters; + }; diff --git a/Documentation/media/uapi/dvb/dvb-frontend-parameters.rst b/Documentation/userspace-api/media/dvb/dvb-frontend-parameters.rst similarity index 98% rename from Documentation/media/uapi/dvb/dvb-frontend-parameters.rst rename to Documentation/userspace-api/media/dvb/dvb-frontend-parameters.rst index 67c2a316019f..83b1bcc6ef54 100644 --- a/Documentation/media/uapi/dvb/dvb-frontend-parameters.rst +++ b/Documentation/userspace-api/media/dvb/dvb-frontend-parameters.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dvbapi.rst b/Documentation/userspace-api/media/dvb/dvbapi.rst similarity index 98% rename from Documentation/media/uapi/dvb/dvbapi.rst rename to Documentation/userspace-api/media/dvb/dvbapi.rst index 0fcc01f182f9..74b16ab3fd94 100644 --- a/Documentation/media/uapi/dvb/dvbapi.rst +++ b/Documentation/userspace-api/media/dvb/dvbapi.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dvbproperty.rst b/Documentation/userspace-api/media/dvb/dvbproperty.rst similarity index 98% rename from Documentation/media/uapi/dvb/dvbproperty.rst rename to Documentation/userspace-api/media/dvb/dvbproperty.rst index 0c4f5598f2be..1716733d24ba 100644 --- a/Documentation/media/uapi/dvb/dvbproperty.rst +++ b/Documentation/userspace-api/media/dvb/dvbproperty.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dvbstb.svg b/Documentation/userspace-api/media/dvb/dvbstb.svg similarity index 99% rename from Documentation/media/uapi/dvb/dvbstb.svg rename to Documentation/userspace-api/media/dvb/dvbstb.svg index c7672148d6ff..b333d0ff944f 100644 --- a/Documentation/media/uapi/dvb/dvbstb.svg +++ b/Documentation/userspace-api/media/dvb/dvbstb.svg @@ -22,7 +22,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/dvb/examples.rst b/Documentation/userspace-api/media/dvb/examples.rst similarity index 93% rename from Documentation/media/uapi/dvb/examples.rst rename to Documentation/userspace-api/media/dvb/examples.rst index eaa41bc8d173..bd0adde86b96 100644 --- a/Documentation/media/uapi/dvb/examples.rst +++ b/Documentation/userspace-api/media/dvb/examples.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-bandwidth-t.rst b/Documentation/userspace-api/media/dvb/fe-bandwidth-t.rst similarity index 95% rename from Documentation/media/uapi/dvb/fe-bandwidth-t.rst rename to Documentation/userspace-api/media/dvb/fe-bandwidth-t.rst index c3d7837b5f87..6293287af67c 100644 --- a/Documentation/media/uapi/dvb/fe-bandwidth-t.rst +++ b/Documentation/userspace-api/media/dvb/fe-bandwidth-t.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-get-frontend.rst b/Documentation/userspace-api/media/dvb/fe-diseqc-recv-slave-reply.rst similarity index 50% rename from Documentation/media/uapi/dvb/fe-get-frontend.rst rename to Documentation/userspace-api/media/dvb/fe-diseqc-recv-slave-reply.rst index 6cd5250d1832..b520974e8c46 100644 --- a/Documentation/media/uapi/dvb/fe-get-frontend.rst +++ b/Documentation/userspace-api/media/dvb/fe-diseqc-recv-slave-reply.rst @@ -3,48 +3,45 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_GET_FRONTEND: +.. _FE_DISEQC_RECV_SLAVE_REPLY: -*************** -FE_GET_FRONTEND -*************** +******************************** +ioctl FE_DISEQC_RECV_SLAVE_REPLY +******************************** Name ==== -FE_GET_FRONTEND - -.. attention:: This ioctl is deprecated. +FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command Synopsis ======== -.. c:function:: int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p) - :name: FE_GET_FRONTEND +.. c:function:: int ioctl( int fd, FE_DISEQC_RECV_SLAVE_REPLY, struct dvb_diseqc_slave_reply *argp ) + :name: FE_DISEQC_RECV_SLAVE_REPLY Arguments ========= ``fd`` - File descriptor returned by :c:func:`open() `. - + File descriptor returned by :ref:`open() `. -``p`` - Points to parameters for tuning operation. +``argp`` + pointer to struct :c:type:`dvb_diseqc_slave_reply`. Description =========== -This ioctl call queries the currently effective frontend parameters. For -this command, read-only access to the device is sufficient. +Receives reply from a DiSEqC 2.0 command. +The received message is stored at the buffer pointed by ``argp``. Return Value ============ @@ -54,16 +51,5 @@ On success 0 is returned. On error -1 is returned, and the ``errno`` variable is set appropriately. -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - .. row 1 - - - ``EINVAL`` - - - Maximum supported symbol rate reached. - Generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst b/Documentation/userspace-api/media/dvb/fe-diseqc-reset-overload.rst similarity index 53% rename from Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst rename to Documentation/userspace-api/media/dvb/fe-diseqc-reset-overload.rst index 88fd2186ca4d..c59af46b8e87 100644 --- a/Documentation/media/uapi/dvb/fe-diseqc-recv-slave-reply.rst +++ b/Documentation/userspace-api/media/dvb/fe-diseqc-reset-overload.rst @@ -3,27 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_DISEQC_RECV_SLAVE_REPLY: +.. _FE_DISEQC_RESET_OVERLOAD: -******************************** -ioctl FE_DISEQC_RECV_SLAVE_REPLY -******************************** +****************************** +ioctl FE_DISEQC_RESET_OVERLOAD +****************************** Name ==== -FE_DISEQC_RECV_SLAVE_REPLY - Receives reply from a DiSEqC 2.0 command +FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it was powered off due - to power overload. Synopsis ======== -.. c:function:: int ioctl( int fd, FE_DISEQC_RECV_SLAVE_REPLY, struct dvb_diseqc_slave_reply *argp ) - :name: FE_DISEQC_RECV_SLAVE_REPLY +.. c:function:: int ioctl( int fd, FE_DISEQC_RESET_OVERLOAD, NULL ) + :name: FE_DISEQC_RESET_OVERLOAD Arguments @@ -32,16 +32,14 @@ Arguments ``fd`` File descriptor returned by :ref:`open() `. -``argp`` - pointer to struct :c:type:`dvb_diseqc_slave_reply`. - - Description =========== -Receives reply from a DiSEqC 2.0 command. +If the bus has been automatically powered off due to power overload, +this ioctl call restores the power to the bus. The call requires +read/write access to the device. This call has no effect if the device +is manually powered off. Not all Digital TV adapters support this ioctl. -The received message is stored at the buffer pointed by ``argp``. Return Value ============ diff --git a/Documentation/media/uapi/dvb/fe-diseqc-send-burst.rst b/Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst similarity index 96% rename from Documentation/media/uapi/dvb/fe-diseqc-send-burst.rst rename to Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst index 8af872d306aa..19b51d0550f7 100644 --- a/Documentation/media/uapi/dvb/fe-diseqc-send-burst.rst +++ b/Documentation/userspace-api/media/dvb/fe-diseqc-send-burst.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx-add-pid.rst b/Documentation/userspace-api/media/dvb/fe-diseqc-send-master-cmd.rst similarity index 50% rename from Documentation/media/uapi/dvb/dmx-add-pid.rst rename to Documentation/userspace-api/media/dvb/fe-diseqc-send-master-cmd.rst index f483268e4ede..f75513d018c8 100644 --- a/Documentation/media/uapi/dvb/dmx-add-pid.rst +++ b/Documentation/userspace-api/media/dvb/fe-diseqc-send-master-cmd.rst @@ -3,49 +3,48 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _DMX_ADD_PID: +.. _FE_DISEQC_SEND_MASTER_CMD: -=========== -DMX_ADD_PID -=========== +******************************* +ioctl FE_DISEQC_SEND_MASTER_CMD +******************************* Name ----- +==== -DMX_ADD_PID +FE_DISEQC_SEND_MASTER_CMD - Sends a DiSEqC command Synopsis --------- +======== -.. c:function:: int ioctl(fd, DMX_ADD_PID, __u16 *pid) - :name: DMX_ADD_PID +.. c:function:: int ioctl( int fd, FE_DISEQC_SEND_MASTER_CMD, struct dvb_diseqc_master_cmd *argp ) + :name: FE_DISEQC_SEND_MASTER_CMD Arguments ---------- +========= ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by :ref:`open() `. -``pid`` - PID number to be filtered. +``argp`` + pointer to struct + :c:type:`dvb_diseqc_master_cmd` Description ------------ - -This ioctl call allows to add multiple PIDs to a transport stream filter -previously set up with :ref:`DMX_SET_PES_FILTER` and output equal to -:c:type:`DMX_OUT_TSDEMUX_TAP `. +=========== +Sends the DiSEqC command pointed by :c:type:`dvb_diseqc_master_cmd` +to the antenna subsystem. Return Value ------------- +============ On success 0 is returned. @@ -54,3 +53,4 @@ appropriately. Generic error codes are described at the :ref:`Generic Error Codes ` chapter. + diff --git a/Documentation/media/uapi/dvb/fe-diseqc-reset-overload.rst b/Documentation/userspace-api/media/dvb/fe-dishnetwork-send-legacy-cmd.rst similarity index 50% rename from Documentation/media/uapi/dvb/fe-diseqc-reset-overload.rst rename to Documentation/userspace-api/media/dvb/fe-dishnetwork-send-legacy-cmd.rst index 92929c2e75db..ea66f72fe5f8 100644 --- a/Documentation/media/uapi/dvb/fe-diseqc-reset-overload.rst +++ b/Documentation/userspace-api/media/dvb/fe-dishnetwork-send-legacy-cmd.rst @@ -3,42 +3,51 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_DISEQC_RESET_OVERLOAD: +.. _FE_DISHNETWORK_SEND_LEGACY_CMD: ****************************** -ioctl FE_DISEQC_RESET_OVERLOAD +FE_DISHNETWORK_SEND_LEGACY_CMD ****************************** Name ==== -FE_DISEQC_RESET_OVERLOAD - Restores the power to the antenna subsystem, if it was powered off due - to power overload. +FE_DISHNETWORK_SEND_LEGACY_CMD Synopsis ======== -.. c:function:: int ioctl( int fd, FE_DISEQC_RESET_OVERLOAD, NULL ) - :name: FE_DISEQC_RESET_OVERLOAD +.. c:function:: int ioctl(int fd, FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd) + :name: FE_DISHNETWORK_SEND_LEGACY_CMD Arguments ========= ``fd`` - File descriptor returned by :ref:`open() `. + File descriptor returned by :c:func:`open() `. + +``cmd`` + Sends the specified raw cmd to the dish via DISEqC. + Description =========== -If the bus has been automatically powered off due to power overload, -this ioctl call restores the power to the bus. The call requires -read/write access to the device. This call has no effect if the device -is manually powered off. Not all Digital TV adapters support this ioctl. +.. 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 diff --git a/Documentation/media/uapi/dvb/fe-enable-high-lnb-voltage.rst b/Documentation/userspace-api/media/dvb/fe-enable-high-lnb-voltage.rst similarity index 96% rename from Documentation/media/uapi/dvb/fe-enable-high-lnb-voltage.rst rename to Documentation/userspace-api/media/dvb/fe-enable-high-lnb-voltage.rst index 32b7d140d80b..9bdf1e898ddc 100644 --- a/Documentation/media/uapi/dvb/fe-enable-high-lnb-voltage.rst +++ b/Documentation/userspace-api/media/dvb/fe-enable-high-lnb-voltage.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-get-event.rst b/Documentation/userspace-api/media/dvb/fe-get-event.rst similarity index 96% rename from Documentation/media/uapi/dvb/fe-get-event.rst rename to Documentation/userspace-api/media/dvb/fe-get-event.rst index 2573d5b9b636..19df41dca238 100644 --- a/Documentation/media/uapi/dvb/fe-get-event.rst +++ b/Documentation/userspace-api/media/dvb/fe-get-event.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst b/Documentation/userspace-api/media/dvb/fe-get-frontend.rst similarity index 51% rename from Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst rename to Documentation/userspace-api/media/dvb/fe-get-frontend.rst index 13811289971b..7968adc8e982 100644 --- a/Documentation/media/uapi/dvb/fe-dishnetwork-send-legacy-cmd.rst +++ b/Documentation/userspace-api/media/dvb/fe-get-frontend.rst @@ -3,27 +3,29 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_DISHNETWORK_SEND_LEGACY_CMD: +.. _FE_GET_FRONTEND: -****************************** -FE_DISHNETWORK_SEND_LEGACY_CMD -****************************** +*************** +FE_GET_FRONTEND +*************** Name ==== -FE_DISHNETWORK_SEND_LEGACY_CMD +FE_GET_FRONTEND + +.. attention:: This ioctl is deprecated. Synopsis ======== -.. c:function:: int ioctl(int fd, FE_DISHNETWORK_SEND_LEGACY_CMD, unsigned long cmd) - :name: FE_DISHNETWORK_SEND_LEGACY_CMD +.. c:function:: int ioctl(int fd, FE_GET_FRONTEND, struct dvb_frontend_parameters *p) + :name: FE_GET_FRONTEND Arguments @@ -32,22 +34,16 @@ Arguments ``fd`` File descriptor returned by :c:func:`open() `. -``cmd`` - Sends the specified raw cmd to the dish via DISEqC. + +``p`` + Points to parameters for tuning operation. 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. +This ioctl call queries the currently effective frontend parameters. For +this command, read-only access to the device is sufficient. Return Value @@ -58,5 +54,16 @@ On success 0 is returned. On error -1 is returned, and the ``errno`` variable is set appropriately. +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + + - .. row 1 + + - ``EINVAL`` + + - Maximum supported symbol rate reached. + Generic error codes are described at the :ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/fe-get-info.rst b/Documentation/userspace-api/media/dvb/fe-get-info.rst similarity index 96% rename from Documentation/media/uapi/dvb/fe-get-info.rst rename to Documentation/userspace-api/media/dvb/fe-get-info.rst index 551e68b11528..80d9f8195ac4 100644 --- a/Documentation/media/uapi/dvb/fe-get-info.rst +++ b/Documentation/userspace-api/media/dvb/fe-get-info.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-get-property.rst b/Documentation/userspace-api/media/dvb/fe-get-property.rst similarity index 97% rename from Documentation/media/uapi/dvb/fe-get-property.rst rename to Documentation/userspace-api/media/dvb/fe-get-property.rst index 99386c7461b3..088d4e319405 100644 --- a/Documentation/media/uapi/dvb/fe-get-property.rst +++ b/Documentation/userspace-api/media/dvb/fe-get-property.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/ca-get-msg.rst b/Documentation/userspace-api/media/dvb/fe-read-ber.rst similarity index 52% rename from Documentation/media/uapi/dvb/ca-get-msg.rst rename to Documentation/userspace-api/media/dvb/fe-read-ber.rst index bcb7955a0ddc..d0a706ac9011 100644 --- a/Documentation/media/uapi/dvb/ca-get-msg.rst +++ b/Documentation/userspace-api/media/dvb/fe-read-ber.rst @@ -3,52 +3,50 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _CA_GET_MSG: +.. _FE_READ_BER: -========== -CA_GET_MSG -========== +*********** +FE_READ_BER +*********** Name ----- +==== -CA_GET_MSG +FE_READ_BER +.. attention:: This ioctl is deprecated. Synopsis --------- +======== -.. c:function:: int ioctl(fd, CA_GET_MSG, struct ca_msg *msg) - :name: CA_GET_MSG +.. c:function:: int ioctl(int fd, FE_READ_BER, uint32_t *ber) + :name: FE_READ_BER Arguments ---------- +========= ``fd`` - File descriptor returned by a previous call to :c:func:`open() `. + File descriptor returned by :c:func:`open() `. -``msg`` - Pointer to struct :c:type:`ca_msg`. +``ber`` + The bit error rate is stored into \*ber. -Description ------------ - -Receives a message via a CI CA module. -.. note:: +Description +=========== - Please notice that, on most drivers, this is done by reading from - the /dev/adapter?/ca? device node. +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. diff --git a/Documentation/media/uapi/dvb/fe-read-ber.rst b/Documentation/userspace-api/media/dvb/fe-read-signal-strength.rst similarity index 60% rename from Documentation/media/uapi/dvb/fe-read-ber.rst rename to Documentation/userspace-api/media/dvb/fe-read-signal-strength.rst index e579d648687e..df79837de47d 100644 --- a/Documentation/media/uapi/dvb/fe-read-ber.rst +++ b/Documentation/userspace-api/media/dvb/fe-read-signal-strength.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_READ_BER: +.. _FE_READ_SIGNAL_STRENGTH: -*********** -FE_READ_BER -*********** +*********************** +FE_READ_SIGNAL_STRENGTH +*********************** Name ==== -FE_READ_BER +FE_READ_SIGNAL_STRENGTH .. attention:: This ioctl is deprecated. Synopsis ======== -.. c:function:: int ioctl(int fd, FE_READ_BER, uint32_t *ber) - :name: FE_READ_BER +.. c:function:: int ioctl( int fd, FE_READ_SIGNAL_STRENGTH, uint16_t *strength) + :name: FE_READ_SIGNAL_STRENGTH Arguments @@ -33,16 +33,16 @@ Arguments ``fd`` File descriptor returned by :c:func:`open() `. -``ber`` - The bit error rate is stored into \*ber. +``strength`` + The signal strength value is stored into \*strength. 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. +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 diff --git a/Documentation/media/uapi/dvb/ca-fclose.rst b/Documentation/userspace-api/media/dvb/fe-read-snr.rst similarity index 52% rename from Documentation/media/uapi/dvb/ca-fclose.rst rename to Documentation/userspace-api/media/dvb/fe-read-snr.rst index e273444ccc67..e56147a40e23 100644 --- a/Documentation/media/uapi/dvb/ca-fclose.rst +++ b/Documentation/userspace-api/media/dvb/fe-read-snr.rst @@ -3,43 +3,50 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _ca_fclose: +.. _FE_READ_SNR: -===================== -Digital TV CA close() -===================== +*********** +FE_READ_SNR +*********** Name ----- +==== -Digital TV CA close() +FE_READ_SNR +.. attention:: This ioctl is deprecated. Synopsis --------- +======== -.. c:function:: int close(int fd) - :name: dvb-ca-close +.. c:function:: int ioctl(int fd, FE_READ_SNR, int16_t *snr) + :name: FE_READ_SNR Arguments ---------- +========= ``fd`` - File descriptor returned by a previous call to :c:func:`open() `. + File descriptor returned by :c:func:`open() `. + +``snr`` + The signal-to-noise ratio is stored into \*snr. + Description ------------ +=========== -This system call closes a previously opened CA device. +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. diff --git a/Documentation/media/uapi/dvb/fe-read-status.rst b/Documentation/userspace-api/media/dvb/fe-read-status.rst similarity index 97% rename from Documentation/media/uapi/dvb/fe-read-status.rst rename to Documentation/userspace-api/media/dvb/fe-read-status.rst index 0dfc9fdf568f..cf781d463a20 100644 --- a/Documentation/media/uapi/dvb/fe-read-status.rst +++ b/Documentation/userspace-api/media/dvb/fe-read-status.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-read-uncorrected-blocks.rst b/Documentation/userspace-api/media/dvb/fe-read-uncorrected-blocks.rst similarity index 96% rename from Documentation/media/uapi/dvb/fe-read-uncorrected-blocks.rst rename to Documentation/userspace-api/media/dvb/fe-read-uncorrected-blocks.rst index 19c532f750aa..d042e8c86930 100644 --- a/Documentation/media/uapi/dvb/fe-read-uncorrected-blocks.rst +++ b/Documentation/userspace-api/media/dvb/fe-read-uncorrected-blocks.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-set-frontend-tune-mode.rst b/Documentation/userspace-api/media/dvb/fe-set-frontend-tune-mode.rst similarity index 96% rename from Documentation/media/uapi/dvb/fe-set-frontend-tune-mode.rst rename to Documentation/userspace-api/media/dvb/fe-set-frontend-tune-mode.rst index 36e8913170e1..8e059967f49c 100644 --- a/Documentation/media/uapi/dvb/fe-set-frontend-tune-mode.rst +++ b/Documentation/userspace-api/media/dvb/fe-set-frontend-tune-mode.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-set-frontend.rst b/Documentation/userspace-api/media/dvb/fe-set-frontend.rst similarity index 97% rename from Documentation/media/uapi/dvb/fe-set-frontend.rst rename to Documentation/userspace-api/media/dvb/fe-set-frontend.rst index 23caae2588d2..960c95cb18a0 100644 --- a/Documentation/media/uapi/dvb/fe-set-frontend.rst +++ b/Documentation/userspace-api/media/dvb/fe-set-frontend.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-set-tone.rst b/Documentation/userspace-api/media/dvb/fe-set-tone.rst similarity index 96% rename from Documentation/media/uapi/dvb/fe-set-tone.rst rename to Documentation/userspace-api/media/dvb/fe-set-tone.rst index fb605e8c9fc4..5726a20c7991 100644 --- a/Documentation/media/uapi/dvb/fe-set-tone.rst +++ b/Documentation/userspace-api/media/dvb/fe-set-tone.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-set-voltage.rst b/Documentation/userspace-api/media/dvb/fe-set-voltage.rst similarity index 97% rename from Documentation/media/uapi/dvb/fe-set-voltage.rst rename to Documentation/userspace-api/media/dvb/fe-set-voltage.rst index c81a8e6a59aa..f3191808f4fd 100644 --- a/Documentation/media/uapi/dvb/fe-set-voltage.rst +++ b/Documentation/userspace-api/media/dvb/fe-set-voltage.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-type-t.rst b/Documentation/userspace-api/media/dvb/fe-type-t.rst similarity index 97% rename from Documentation/media/uapi/dvb/fe-type-t.rst rename to Documentation/userspace-api/media/dvb/fe-type-t.rst index 9720d2f7ba35..1617a8cc9045 100644 --- a/Documentation/media/uapi/dvb/fe-type-t.rst +++ b/Documentation/userspace-api/media/dvb/fe-type-t.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe_property_parameters.rst b/Documentation/userspace-api/media/dvb/fe_property_parameters.rst similarity index 99% rename from Documentation/media/uapi/dvb/fe_property_parameters.rst rename to Documentation/userspace-api/media/dvb/fe_property_parameters.rst index 2fd2954d8dae..3f4ced2800e3 100644 --- a/Documentation/media/uapi/dvb/fe_property_parameters.rst +++ b/Documentation/userspace-api/media/dvb/fe_property_parameters.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/sdr-formats.rst b/Documentation/userspace-api/media/dvb/frontend-header.rst similarity index 52% rename from Documentation/media/uapi/v4l/sdr-formats.rst rename to Documentation/userspace-api/media/dvb/frontend-header.rst index f452f5574ebb..cf8e515e5e1f 100644 --- a/Documentation/media/uapi/v4l/sdr-formats.rst +++ b/Documentation/userspace-api/media/dvb/frontend-header.rst @@ -3,27 +3,11 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _sdr-formats: +Frontend uAPI data types +======================== -*********** -SDR Formats -*********** - -These formats are used for :ref:`SDR ` interface only. - - -.. toctree:: - :maxdepth: 1 - - pixfmt-sdr-cu08 - pixfmt-sdr-cu16le - pixfmt-sdr-cs08 - pixfmt-sdr-cs14le - pixfmt-sdr-ru12le - pixfmt-sdr-pcu16be - pixfmt-sdr-pcu18be - pixfmt-sdr-pcu20be +.. kernel-doc:: include/uapi/linux/dvb/frontend.h diff --git a/Documentation/media/uapi/dvb/frontend-property-cable-systems.rst b/Documentation/userspace-api/media/dvb/frontend-property-cable-systems.rst similarity index 97% rename from Documentation/media/uapi/dvb/frontend-property-cable-systems.rst rename to Documentation/userspace-api/media/dvb/frontend-property-cable-systems.rst index 97fbfc228c10..56657a6ec6ff 100644 --- a/Documentation/media/uapi/dvb/frontend-property-cable-systems.rst +++ b/Documentation/userspace-api/media/dvb/frontend-property-cable-systems.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend-property-satellite-systems.rst b/Documentation/userspace-api/media/dvb/frontend-property-satellite-systems.rst similarity index 97% rename from Documentation/media/uapi/dvb/frontend-property-satellite-systems.rst rename to Documentation/userspace-api/media/dvb/frontend-property-satellite-systems.rst index 2bc880a3c826..e64fd625c476 100644 --- a/Documentation/media/uapi/dvb/frontend-property-satellite-systems.rst +++ b/Documentation/userspace-api/media/dvb/frontend-property-satellite-systems.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend-property-terrestrial-systems.rst b/Documentation/userspace-api/media/dvb/frontend-property-terrestrial-systems.rst similarity index 99% rename from Documentation/media/uapi/dvb/frontend-property-terrestrial-systems.rst rename to Documentation/userspace-api/media/dvb/frontend-property-terrestrial-systems.rst index c20af13297e5..1079522b2425 100644 --- a/Documentation/media/uapi/dvb/frontend-property-terrestrial-systems.rst +++ b/Documentation/userspace-api/media/dvb/frontend-property-terrestrial-systems.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend-stat-properties.rst b/Documentation/userspace-api/media/dvb/frontend-stat-properties.rst similarity index 99% rename from Documentation/media/uapi/dvb/frontend-stat-properties.rst rename to Documentation/userspace-api/media/dvb/frontend-stat-properties.rst index 546464db04b5..ae6ed5128deb 100644 --- a/Documentation/media/uapi/dvb/frontend-stat-properties.rst +++ b/Documentation/userspace-api/media/dvb/frontend-stat-properties.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend.rst b/Documentation/userspace-api/media/dvb/frontend.rst similarity index 97% rename from Documentation/media/uapi/dvb/frontend.rst rename to Documentation/userspace-api/media/dvb/frontend.rst index 7ff225dfe11c..41ad519ca502 100644 --- a/Documentation/media/uapi/dvb/frontend.rst +++ b/Documentation/userspace-api/media/dvb/frontend.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/fe-read-signal-strength.rst b/Documentation/userspace-api/media/dvb/frontend_f_close.rst similarity index 57% rename from Documentation/media/uapi/dvb/fe-read-signal-strength.rst rename to Documentation/userspace-api/media/dvb/frontend_f_close.rst index 0a0c0c2ff207..582e19a83c1a 100644 --- a/Documentation/media/uapi/dvb/fe-read-signal-strength.rst +++ b/Documentation/userspace-api/media/dvb/frontend_f_close.rst @@ -3,29 +3,32 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _FE_READ_SIGNAL_STRENGTH: +.. _frontend_f_close: -*********************** -FE_READ_SIGNAL_STRENGTH -*********************** +*************************** +Digital TV frontend close() +*************************** Name ==== -FE_READ_SIGNAL_STRENGTH +fe-close - Close a frontend device -.. attention:: This ioctl is deprecated. Synopsis ======== -.. c:function:: int ioctl( int fd, FE_READ_SIGNAL_STRENGTH, uint16_t *strength) - :name: FE_READ_SIGNAL_STRENGTH +.. code-block:: c + #include + + +.. c:function:: int close( int fd ) + :name: dvb-fe-close Arguments ========= @@ -33,16 +36,13 @@ Arguments ``fd`` File descriptor returned by :c:func:`open() `. -``strength`` - The signal strength value is stored into \*strength. - 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. +This system call closes a previously opened front-end device. After +closing a front-end device, its corresponding hardware might be powered +down automatically. Return Value diff --git a/Documentation/media/uapi/dvb/frontend_f_open.rst b/Documentation/userspace-api/media/dvb/frontend_f_open.rst similarity index 98% rename from Documentation/media/uapi/dvb/frontend_f_open.rst rename to Documentation/userspace-api/media/dvb/frontend_f_open.rst index 6a46ec5acf7b..0be3b249d33b 100644 --- a/Documentation/media/uapi/dvb/frontend_f_open.rst +++ b/Documentation/userspace-api/media/dvb/frontend_f_open.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend_fcalls.rst b/Documentation/userspace-api/media/dvb/frontend_fcalls.rst similarity index 93% rename from Documentation/media/uapi/dvb/frontend_fcalls.rst rename to Documentation/userspace-api/media/dvb/frontend_fcalls.rst index 9b3586f538ea..2b5e7a4dba9e 100644 --- a/Documentation/media/uapi/dvb/frontend_fcalls.rst +++ b/Documentation/userspace-api/media/dvb/frontend_fcalls.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend_legacy_api.rst b/Documentation/userspace-api/media/dvb/frontend_legacy_api.rst similarity index 95% rename from Documentation/media/uapi/dvb/frontend_legacy_api.rst rename to Documentation/userspace-api/media/dvb/frontend_legacy_api.rst index 1ea749d09ca2..1bd804f9b364 100644 --- a/Documentation/media/uapi/dvb/frontend_legacy_api.rst +++ b/Documentation/userspace-api/media/dvb/frontend_legacy_api.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend_legacy_dvbv3_api.rst b/Documentation/userspace-api/media/dvb/frontend_legacy_dvbv3_api.rst similarity index 93% rename from Documentation/media/uapi/dvb/frontend_legacy_dvbv3_api.rst rename to Documentation/userspace-api/media/dvb/frontend_legacy_dvbv3_api.rst index 1567bc73855a..29ad0f9b90a4 100644 --- a/Documentation/media/uapi/dvb/frontend_legacy_dvbv3_api.rst +++ b/Documentation/userspace-api/media/dvb/frontend_legacy_dvbv3_api.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/headers.rst b/Documentation/userspace-api/media/dvb/headers.rst similarity index 93% rename from Documentation/media/uapi/dvb/headers.rst rename to Documentation/userspace-api/media/dvb/headers.rst index edeabd9e8e90..ffd8f432484a 100644 --- a/Documentation/media/uapi/dvb/headers.rst +++ b/Documentation/userspace-api/media/dvb/headers.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/intro.rst b/Documentation/userspace-api/media/dvb/intro.rst similarity index 99% rename from Documentation/media/uapi/dvb/intro.rst rename to Documentation/userspace-api/media/dvb/intro.rst index f1384616ac4e..f1235ef4599e 100644 --- a/Documentation/media/uapi/dvb/intro.rst +++ b/Documentation/userspace-api/media/dvb/intro.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst b/Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst similarity index 95% rename from Documentation/media/uapi/dvb/legacy_dvb_apis.rst rename to Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst index a43b4c36d935..17c3b062afb3 100644 --- a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst +++ b/Documentation/userspace-api/media/dvb/legacy_dvb_apis.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/userspace-api/media/dvb/net-add-if.rst b/Documentation/userspace-api/media/dvb/net-add-if.rst new file mode 100644 index 000000000000..e75ec4d80a08 --- /dev/null +++ b/Documentation/userspace-api/media/dvb/net-add-if.rst @@ -0,0 +1,60 @@ +.. Permission is granted to copy, distribute and/or modify this +.. document under the terms of the GNU Free Documentation License, +.. Version 1.1 or any later version published by the Free Software +.. Foundation, with no Invariant Sections, no Front-Cover Texts +.. and no Back-Cover Texts. A copy of the license is included at +.. Documentation/userspace-api/media/fdl-appendix.rst. +.. +.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections + +.. _NET_ADD_IF: + +**************** +ioctl NET_ADD_IF +**************** + +Name +==== + +NET_ADD_IF - Creates a new network interface for a given Packet ID. + + +Synopsis +======== + +.. c:function:: int ioctl( int fd, NET_ADD_IF, struct dvb_net_if *net_if ) + :name: NET_ADD_IF + + +Arguments +========= + +``fd`` + File descriptor returned by :ref:`open() `. + +``net_if`` + pointer to struct :c:type:`dvb_net_if` + + +Description +=========== + +The NET_ADD_IF ioctl system call selects the Packet ID (PID) that +contains a TCP/IP traffic, the type of encapsulation to be used (MPE or +ULE) and the interface number for the new interface to be created. When +the system call successfully returns, a new virtual network interface is +created. + +The struct :c:type:`dvb_net_if`::ifnum field will be +filled with the number of the created interface. + +Return Value +============ + +On success 0 is returned, and :c:type:`ca_slot_info` is filled. + +On error -1 is returned, and the ``errno`` variable is set +appropriately. + +The generic error codes are described at the +:ref:`Generic Error Codes ` chapter. diff --git a/Documentation/media/uapi/dvb/net-add-if.rst b/Documentation/userspace-api/media/dvb/net-get-if.rst similarity index 58% rename from Documentation/media/uapi/dvb/net-add-if.rst rename to Documentation/userspace-api/media/dvb/net-get-if.rst index 1188641b453e..c5421d9a8c0b 100644 --- a/Documentation/media/uapi/dvb/net-add-if.rst +++ b/Documentation/userspace-api/media/dvb/net-get-if.rst @@ -3,27 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _NET_ADD_IF: +.. _NET_GET_IF: **************** -ioctl NET_ADD_IF +ioctl NET_GET_IF **************** Name ==== -NET_ADD_IF - Creates a new network interface for a given Packet ID. +NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF `. Synopsis ======== -.. c:function:: int ioctl( int fd, NET_ADD_IF, struct dvb_net_if *net_if ) - :name: NET_ADD_IF +.. c:function:: int ioctl( int fd, NET_GET_IF, struct dvb_net_if *net_if ) + :name: NET_GET_IF Arguments @@ -39,14 +39,13 @@ Arguments Description =========== -The NET_ADD_IF ioctl system call selects the Packet ID (PID) that -contains a TCP/IP traffic, the type of encapsulation to be used (MPE or -ULE) and the interface number for the new interface to be created. When -the system call successfully returns, a new virtual network interface is -created. +The NET_GET_IF ioctl uses the interface number given by the struct +:c:type:`dvb_net_if`::ifnum field and fills the content of +struct :c:type:`dvb_net_if` with the packet ID and +encapsulation type used on such interface. If the interface was not +created yet with :ref:`NET_ADD_IF `, it will return -1 and fill +the ``errno`` with ``EINVAL`` error code. -The struct :c:type:`dvb_net_if`::ifnum field will be -filled with the number of the created interface. Return Value ============ diff --git a/Documentation/media/uapi/dvb/net-get-if.rst b/Documentation/userspace-api/media/dvb/net-remove-if.rst similarity index 54% rename from Documentation/media/uapi/dvb/net-get-if.rst rename to Documentation/userspace-api/media/dvb/net-remove-if.rst index 7c4ef4b9d6cc..d530559f66f1 100644 --- a/Documentation/media/uapi/dvb/net-get-if.rst +++ b/Documentation/userspace-api/media/dvb/net-remove-if.rst @@ -3,27 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _NET_GET_IF: +.. _NET_REMOVE_IF: -**************** -ioctl NET_GET_IF -**************** +******************* +ioctl NET_REMOVE_IF +******************* Name ==== -NET_GET_IF - Read the configuration data of an interface created via - :ref:`NET_ADD_IF `. +NET_REMOVE_IF - Removes a network interface. Synopsis ======== -.. c:function:: int ioctl( int fd, NET_GET_IF, struct dvb_net_if *net_if ) - :name: NET_GET_IF +.. c:function:: int ioctl( int fd, NET_REMOVE_IF, int ifnum ) + :name: NET_REMOVE_IF Arguments @@ -33,18 +33,14 @@ Arguments File descriptor returned by :ref:`open() `. ``net_if`` - pointer to struct :c:type:`dvb_net_if` + number of the interface to be removed Description =========== -The NET_GET_IF ioctl uses the interface number given by the struct -:c:type:`dvb_net_if`::ifnum field and fills the content of -struct :c:type:`dvb_net_if` with the packet ID and -encapsulation type used on such interface. If the interface was not -created yet with :ref:`NET_ADD_IF `, it will return -1 and fill -the ``errno`` with ``EINVAL`` error code. +The NET_REMOVE_IF ioctl deletes an interface previously created via +:ref:`NET_ADD_IF `. Return Value diff --git a/Documentation/media/uapi/dvb/dvb-frontend-event.rst b/Documentation/userspace-api/media/dvb/net-types.rst similarity index 61% rename from Documentation/media/uapi/dvb/dvb-frontend-event.rst rename to Documentation/userspace-api/media/dvb/net-types.rst index ad4af66040c7..94323cffe8af 100644 --- a/Documentation/media/uapi/dvb/dvb-frontend-event.rst +++ b/Documentation/userspace-api/media/dvb/net-types.rst @@ -3,20 +3,14 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. c:type:: dvb_frontend_event +.. _net_types: -*************** -frontend events -*************** +************** +Net Data Types +************** - -.. code-block:: c - - struct dvb_frontend_event { - fe_status_t status; - struct dvb_frontend_parameters parameters; - }; +.. kernel-doc:: include/uapi/linux/dvb/net.h diff --git a/Documentation/media/uapi/dvb/net.rst b/Documentation/userspace-api/media/dvb/net.rst similarity index 96% rename from Documentation/media/uapi/dvb/net.rst rename to Documentation/userspace-api/media/dvb/net.rst index 833daa381968..084f33d1ba28 100644 --- a/Documentation/media/uapi/dvb/net.rst +++ b/Documentation/userspace-api/media/dvb/net.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/query-dvb-frontend-info.rst b/Documentation/userspace-api/media/dvb/query-dvb-frontend-info.rst similarity index 93% rename from Documentation/media/uapi/dvb/query-dvb-frontend-info.rst rename to Documentation/userspace-api/media/dvb/query-dvb-frontend-info.rst index 9a6badc1d295..d854ccf42ccf 100644 --- a/Documentation/media/uapi/dvb/query-dvb-frontend-info.rst +++ b/Documentation/userspace-api/media/dvb/query-dvb-frontend-info.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/audio-select-source.rst b/Documentation/userspace-api/media/dvb/video-clear-buffer.rst similarity index 55% rename from Documentation/media/uapi/dvb/audio-select-source.rst rename to Documentation/userspace-api/media/dvb/video-clear-buffer.rst index c5ed6243b11c..ba7a13302862 100644 --- a/Documentation/media/uapi/dvb/audio-select-source.rst +++ b/Documentation/userspace-api/media/dvb/video-clear-buffer.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_SELECT_SOURCE: +.. _VIDEO_CLEAR_BUFFER: -=================== -AUDIO_SELECT_SOURCE -=================== +================== +VIDEO_CLEAR_BUFFER +================== Name ---- -AUDIO_SELECT_SOURCE +VIDEO_CLEAR_BUFFER -.. attention:: This ioctl is deprecated +.. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_SELECT_SOURCE, struct audio_stream_source *source) - :name: AUDIO_SELECT_SOURCE +.. c:function:: int ioctl(fd, VIDEO_CLEAR_BUFFER) + :name: VIDEO_CLEAR_BUFFER Arguments @@ -35,26 +35,24 @@ Arguments :stub-columns: 0 - - + - .. row 1 - int fd - File descriptor returned by a previous call to open(). - - + - .. row 2 - - audio_stream_source_t source + - int request - - Indicates the source that shall be used for the Audio stream. + - Equals VIDEO_CLEAR_BUFFER for this command. 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. +This ioctl call clears all video buffers in the driver and in the +decoder hardware. Return Value diff --git a/Documentation/userspace-api/media/dvb/video-command.rst b/Documentation/userspace-api/media/dvb/video-command.rst new file mode 100644 index 000000000000..d96d764d0eef --- /dev/null +++ b/Documentation/userspace-api/media/dvb/video-command.rst @@ -0,0 +1,105 @@ +.. Permission is granted to copy, distribute and/or modify this +.. document under the terms of the GNU Free Documentation License, +.. Version 1.1 or any later version published by the Free Software +.. Foundation, with no Invariant Sections, no Front-Cover Texts +.. and no Back-Cover Texts. A copy of the license is included at +.. Documentation/userspace-api/media/fdl-appendix.rst. +.. +.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections + +.. _VIDEO_COMMAND: + +============= +VIDEO_COMMAND +============= + +Name +---- + +VIDEO_COMMAND + +.. attention:: This ioctl is deprecated. + +Synopsis +-------- + +.. c:function:: int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd) + :name: VIDEO_COMMAND + + +Arguments +--------- + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + + - .. row 1 + + - int fd + + - File descriptor returned by a previous call to open(). + + - .. row 2 + + - int request + + - Equals VIDEO_COMMAND for this command. + + - .. row 3 + + - struct video_command \*cmd + + - Commands the decoder. + + +Description +----------- + +This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders +this ioctl has been replaced by the +:ref:`VIDIOC_DECODER_CMD` ioctl. + +This ioctl commands the decoder. The ``video_command`` struct is a +subset of the ``v4l2_decoder_cmd`` struct, so refer to the +:ref:`VIDIOC_DECODER_CMD` documentation for +more information. + +.. c:type:: struct video_command + +.. code-block:: c + + /* The structure must be zeroed before use by the application + This ensures it can be extended safely in the future. */ + struct video_command { + __u32 cmd; + __u32 flags; + union { + struct { + __u64 pts; + } stop; + + struct { + /* 0 or 1000 specifies normal speed, + 1 specifies forward single stepping, + -1 specifies backward single stepping, + >1: playback at speed/1000 of the normal speed, + <-1: reverse playback at (-speed/1000) of the normal speed. */ + __s32 speed; + __u32 format; + } play; + + struct { + __u32 data[16]; + } raw; + }; + }; + + +Return 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 ` chapter. diff --git a/Documentation/media/uapi/dvb/video-get-size.rst b/Documentation/userspace-api/media/dvb/video-continue.rst similarity index 65% rename from Documentation/media/uapi/dvb/video-get-size.rst rename to Documentation/userspace-api/media/dvb/video-continue.rst index cc92189d31fd..bb18514ac5e9 100644 --- a/Documentation/media/uapi/dvb/video-get-size.rst +++ b/Documentation/userspace-api/media/dvb/video-continue.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_GET_SIZE: +.. _VIDEO_CONTINUE: ============== -VIDEO_GET_SIZE +VIDEO_CONTINUE ============== Name ---- -VIDEO_GET_SIZE +VIDEO_CONTINUE .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, VIDEO_GET_SIZE, video_size_t *size) - :name: VIDEO_GET_SIZE +.. c:function:: int ioctl(fd, VIDEO_CONTINUE) + :name: VIDEO_CONTINUE Arguments @@ -45,29 +45,17 @@ Arguments - int request - - Equals VIDEO_GET_SIZE for this command. - - - .. row 3 - - - video_size_t \*size - - - Returns the size and aspect ratio. + - Equals VIDEO_CONTINUE for this command. Description ----------- -This ioctl returns the size and aspect ratio. - -.. c:type:: video_size_t - -.. code-block::c +This ioctl is for Digital TV devices only. To control a V4L2 decoder use the +V4L2 :ref:`VIDIOC_DECODER_CMD` instead. - typedef struct { - int w; - int h; - video_format_t aspect_ratio; - } video_size_t; +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 diff --git a/Documentation/media/uapi/dvb/video-try-command.rst b/Documentation/userspace-api/media/dvb/video-fast-forward.rst similarity index 55% rename from Documentation/media/uapi/dvb/video-try-command.rst rename to Documentation/userspace-api/media/dvb/video-fast-forward.rst index 37ecf8e91eb8..1f6ec89574d1 100644 --- a/Documentation/media/uapi/dvb/video-try-command.rst +++ b/Documentation/userspace-api/media/dvb/video-fast-forward.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_TRY_COMMAND: +.. _VIDEO_FAST_FORWARD: -================= -VIDEO_TRY_COMMAND -================= +================== +VIDEO_FAST_FORWARD +================== Name ---- -VIDEO_TRY_COMMAND +VIDEO_FAST_FORWARD .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, VIDEO_TRY_COMMAND, struct video_command *cmd) - :name: VIDEO_TRY_COMMAND +.. c:function:: int ioctl(fd, VIDEO_FAST_FORWARD, int nFrames) + :name: VIDEO_FAST_FORWARD Arguments @@ -45,26 +45,21 @@ Arguments - int request - - Equals VIDEO_TRY_COMMAND for this command. + - Equals VIDEO_FAST_FORWARD for this command. - .. row 3 - - struct video_command \*cmd + - int nFrames - - Try a decoder command. + - The number of frames to skip. Description ----------- -This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders -this ioctl has been replaced by the -:ref:`VIDIOC_TRY_DECODER_CMD ` ioctl. - -This ioctl tries a decoder command. The ``video_command`` struct is a -subset of the ``v4l2_decoder_cmd`` struct, so refer to the -:ref:`VIDIOC_TRY_DECODER_CMD ` documentation -for more information. +This ioctl call asks the Video Device to skip decoding of N number of +I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is +selected. Return Value @@ -73,3 +68,16 @@ Return 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 ` chapter. + + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + + - .. row 1 + + - ``EPERM`` + + - Mode VIDEO_SOURCE_MEMORY not selected. diff --git a/Documentation/media/uapi/dvb/video-fwrite.rst b/Documentation/userspace-api/media/dvb/video-fclose.rst similarity index 50% rename from Documentation/media/uapi/dvb/video-fwrite.rst rename to Documentation/userspace-api/media/dvb/video-fclose.rst index eb35b79eb85c..f9d2a8ebe4a4 100644 --- a/Documentation/media/uapi/dvb/video-fwrite.rst +++ b/Documentation/userspace-api/media/dvb/video-fclose.rst @@ -3,27 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _video_fwrite: +.. _video_fclose: ================= -dvb video write() +dvb video close() ================= Name ---- -dvb video write() +dvb video close() .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: size_t write(int fd, const void *buf, size_t count) +.. c:function:: int close(int fd) Arguments @@ -40,27 +40,11 @@ Arguments - File descriptor returned by a previous call to open(). - - .. row 2 - - - void \*buf - - - Pointer to the buffer containing the PES data. - - - .. row 3 - - - size_t count - - - Size of buf. - Description ----------- -This system call can only be used if VIDEO_SOURCE_MEMORY is selected -in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in -PES format, unless the capability allows other formats. If O_NONBLOCK -is not specified the function will block until buffer space is -available. The amount of data to be transferred is implied by count. +This system call closes a previously opened video device. Return Value @@ -73,18 +57,6 @@ Return Value - .. row 1 - - ``EPERM`` - - - Mode VIDEO_SOURCE_MEMORY not selected. - - - .. row 2 - - - ``ENOMEM`` - - - Attempted to write more data than the internal buffer can hold. - - - .. row 3 - - ``EBADF`` - fd is not a valid open file descriptor. diff --git a/Documentation/media/uapi/dvb/audio-fopen.rst b/Documentation/userspace-api/media/dvb/video-fopen.rst similarity index 53% rename from Documentation/media/uapi/dvb/audio-fopen.rst rename to Documentation/userspace-api/media/dvb/video-fopen.rst index 2cf4d83661f4..a418cf6d772e 100644 --- a/Documentation/media/uapi/dvb/audio-fopen.rst +++ b/Documentation/userspace-api/media/dvb/video-fopen.rst @@ -3,28 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _audio_fopen: +.. _video_fopen: -======================= -Digital TV audio open() -======================= +================ +dvb video open() +================ Name ---- -Digital TV audio open() +dvb video open() -.. attention:: This ioctl is deprecated +.. attention:: This ioctl is deprecated. Synopsis -------- .. c:function:: int open(const char *deviceName, int flags) - :name: dvb-audio-open Arguments @@ -39,7 +38,7 @@ Arguments - const char \*deviceName - - Name of specific audio device. + - Name of specific video device. - .. row 2 @@ -71,19 +70,21 @@ Arguments Description ----------- -This system call opens a named audio device (e.g. -/dev/dvb/adapter0/audio0) for subsequent use. When an open() call has -succeeded, the device will be ready for use. The significance of -blocking or non-blocking mode is described in the documentation for -functions where there is a difference. It does not affect the semantics -of the open() call itself. A device opened in blocking mode can later be -put into non-blocking mode (and vice versa) using the F_SETFL command -of the fcntl system call. This is a standard system call, documented in -the Linux manual page for fcntl. Only one user can open the Audio Device -in O_RDWR mode. All other attempts to open the device in this mode will -fail, and an error code will be returned. If the Audio Device is opened -in O_RDONLY mode, the only ioctl call that can be used is -AUDIO_GET_STATUS. All other call will return with an error code. +This system call opens a named video device (e.g. +/dev/dvb/adapter0/video0) for subsequent use. + +When an open() call has succeeded, the device will be ready for use. The +significance of blocking or non-blocking mode is described in the +documentation for functions where there is a difference. It does not +affect the semantics of the open() call itself. A device opened in +blocking mode can later be put into non-blocking mode (and vice versa) +using the F_SETFL command of the fcntl system call. This is a standard +system call, documented in the Linux manual page for fcntl. Only one +user can open the Video Device in O_RDWR mode. All other attempts to +open the device in this mode will fail, and an error-code will be +returned. If the Video Device is opened in O_RDONLY mode, the only +ioctl call that can be used is VIDEO_GET_STATUS. All other call will +return an error code. Return Value @@ -104,11 +105,17 @@ Return Value - .. row 2 + - ``EINTERNAL`` + + - Internal error. + + - .. row 3 + - ``EBUSY`` - Device or resource busy. - - .. row 3 + - .. row 4 - ``EINVAL`` diff --git a/Documentation/media/uapi/dvb/video-set-format.rst b/Documentation/userspace-api/media/dvb/video-freeze.rst similarity index 50% rename from Documentation/media/uapi/dvb/video-set-format.rst rename to Documentation/userspace-api/media/dvb/video-freeze.rst index 63e60214ab37..46f287faa7fe 100644 --- a/Documentation/media/uapi/dvb/video-set-format.rst +++ b/Documentation/userspace-api/media/dvb/video-freeze.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_SET_FORMAT: +.. _VIDEO_FREEZE: -================ -VIDEO_SET_FORMAT -================ +============ +VIDEO_FREEZE +============ Name ---- -VIDEO_SET_FORMAT +VIDEO_FREEZE .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format) - :name: VIDEO_SET_FORMAT +.. c:function:: int ioctl(fd, VIDEO_FREEZE) + :name: VIDEO_FREEZE Arguments @@ -45,31 +45,22 @@ Arguments - int request - - Equals VIDEO_SET_FORMAT for this command. - - - .. row 3 - - - video_format_t format - - - video format of TV as defined in section ??. + - Equals VIDEO_FREEZE for this command. Description ----------- -This ioctl sets the screen format (aspect ratio) of the connected output -device (TV) so that the output of the decoder can be adjusted -accordingly. - -.. c:type:: video_format_t +This ioctl is for Digital TV devices only. To control a V4L2 decoder use the +V4L2 :ref:`VIDIOC_DECODER_CMD` instead. -.. code-block:: c +This ioctl call suspends the live video stream being played. Decoding +and playing are frozen. It is then possible to restart the decoding and +playing process of the video stream using the VIDEO_CONTINUE command. +If VIDEO_SOURCE_MEMORY is selected in the ioctl call +VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data +until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed. - typedef enum { - VIDEO_FORMAT_4_3, /* Select 4:3 format */ - VIDEO_FORMAT_16_9, /* Select 16:9 format. */ - VIDEO_FORMAT_221_1 /* 2.21:1 */ - } video_format_t; Return Value ------------ @@ -77,16 +68,3 @@ Return 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 ` chapter. - - - -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - .. row 1 - - - ``EINVAL`` - - - format is not a valid video format. diff --git a/Documentation/media/uapi/dvb/video-slowmotion.rst b/Documentation/userspace-api/media/dvb/video-fwrite.rst similarity index 50% rename from Documentation/media/uapi/dvb/video-slowmotion.rst rename to Documentation/userspace-api/media/dvb/video-fwrite.rst index 32c934aaf2ba..08dfafa9c6a1 100644 --- a/Documentation/media/uapi/dvb/video-slowmotion.rst +++ b/Documentation/userspace-api/media/dvb/video-fwrite.rst @@ -3,28 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_SLOWMOTION: +.. _video_fwrite: -================ -VIDEO_SLOWMOTION -================ +================= +dvb video write() +================= Name ---- -VIDEO_SLOWMOTION +dvb video write() .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_SLOWMOTION, int nFrames) - :name: VIDEO_SLOWMOTION +.. c:function:: size_t write(int fd, const void *buf, size_t count) Arguments @@ -43,34 +42,30 @@ Arguments - .. row 2 - - int request + - void \*buf - - Equals VIDEO_SLOWMOTION for this command. + - Pointer to the buffer containing the PES data. - .. row 3 - - int nFrames + - size_t count - - The number of times to repeat each frame. + - Size of buf. Description ----------- -This ioctl call asks the video device to repeat decoding frames N number -of times. This call can only be used if VIDEO_SOURCE_MEMORY is -selected. +This system call can only be used if VIDEO_SOURCE_MEMORY is selected +in the ioctl call VIDEO_SELECT_SOURCE. The data provided shall be in +PES format, unless the capability allows other formats. If O_NONBLOCK +is not specified the function will block until buffer space is +available. The amount of data to be transferred is implied by count. Return Value ------------ -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 ` chapter. - - - .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -81,3 +76,15 @@ appropriately. The generic error codes are described at the - ``EPERM`` - Mode VIDEO_SOURCE_MEMORY not selected. + + - .. row 2 + + - ``ENOMEM`` + + - Attempted to write more data than the internal buffer can hold. + + - .. row 3 + + - ``EBADF`` + + - fd is not a valid open file descriptor. diff --git a/Documentation/media/uapi/dvb/audio-channel-select.rst b/Documentation/userspace-api/media/dvb/video-get-capabilities.rst similarity index 53% rename from Documentation/media/uapi/dvb/audio-channel-select.rst rename to Documentation/userspace-api/media/dvb/video-get-capabilities.rst index ebb2f121c4c8..f6f19df5a3b4 100644 --- a/Documentation/media/uapi/dvb/audio-channel-select.rst +++ b/Documentation/userspace-api/media/dvb/video-get-capabilities.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_CHANNEL_SELECT: +.. _VIDEO_GET_CAPABILITIES: -==================== -AUDIO_CHANNEL_SELECT -==================== +====================== +VIDEO_GET_CAPABILITIES +====================== Name ---- -AUDIO_CHANNEL_SELECT +VIDEO_GET_CAPABILITIES -.. attention:: This ioctl is deprecated +.. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_CHANNEL_SELECT, struct *audio_channel_select) - :name: AUDIO_CHANNEL_SELECT +.. c:function:: int ioctl(fd, VIDEO_GET_CAPABILITIES, unsigned int *cap) + :name: VIDEO_GET_CAPABILITIES Arguments @@ -35,27 +35,31 @@ Arguments :stub-columns: 0 - - + - .. row 1 - int fd - File descriptor returned by a previous call to open(). - - + - .. row 2 - - audio_channel_select_t ch + - int request - - Select the output format of the audio (mono left/right, stereo). + - Equals VIDEO_GET_CAPABILITIES for this command. + + - .. row 3 + + - unsigned int \*cap + + - Pointer to a location where to store the capability information. Description ----------- -This ioctl is for Digital TV 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. +This ioctl call asks the video device about its decoding capabilities. +On success it returns and integer which has bits set according to the +defines in section ??. Return Value diff --git a/Documentation/media/uapi/dvb/video-get-event.rst b/Documentation/userspace-api/media/dvb/video-get-event.rst similarity index 98% rename from Documentation/media/uapi/dvb/video-get-event.rst rename to Documentation/userspace-api/media/dvb/video-get-event.rst index 7f03fbe3d3b0..6db8e6337c4f 100644 --- a/Documentation/media/uapi/dvb/video-get-event.rst +++ b/Documentation/userspace-api/media/dvb/video-get-event.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/video-clear-buffer.rst b/Documentation/userspace-api/media/dvb/video-get-frame-count.rst similarity index 56% rename from Documentation/media/uapi/dvb/video-clear-buffer.rst rename to Documentation/userspace-api/media/dvb/video-get-frame-count.rst index 5eb5546e8ce4..4152a42daeb3 100644 --- a/Documentation/media/uapi/dvb/video-clear-buffer.rst +++ b/Documentation/userspace-api/media/dvb/video-get-frame-count.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_CLEAR_BUFFER: +.. _VIDEO_GET_FRAME_COUNT: -================== -VIDEO_CLEAR_BUFFER -================== +===================== +VIDEO_GET_FRAME_COUNT +===================== Name ---- -VIDEO_CLEAR_BUFFER +VIDEO_GET_FRAME_COUNT .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_CLEAR_BUFFER) - :name: VIDEO_CLEAR_BUFFER +.. c:function:: int ioctl(int fd, VIDEO_GET_FRAME_COUNT, __u64 *pts) + :name: VIDEO_GET_FRAME_COUNT Arguments @@ -45,14 +45,25 @@ Arguments - int request - - Equals VIDEO_CLEAR_BUFFER for this command. + - Equals VIDEO_GET_FRAME_COUNT for this command. + + - .. row 3 + + - __u64 \*pts + + - Returns the number of frames displayed since the decoder was + started. Description ----------- -This ioctl call clears all video buffers in the driver and in the -decoder hardware. +This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders +this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_FRAME`` +control. + +This ioctl call asks the Video Device to return the number of displayed +frames since the decoder was started. Return Value diff --git a/Documentation/media/uapi/dvb/video-set-display-format.rst b/Documentation/userspace-api/media/dvb/video-get-pts.rst similarity index 54% rename from Documentation/media/uapi/dvb/video-set-display-format.rst rename to Documentation/userspace-api/media/dvb/video-get-pts.rst index ffdefa341207..f957df792ae1 100644 --- a/Documentation/media/uapi/dvb/video-set-display-format.rst +++ b/Documentation/userspace-api/media/dvb/video-get-pts.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_SET_DISPLAY_FORMAT: +.. _VIDEO_GET_PTS: -======================== -VIDEO_SET_DISPLAY_FORMAT -======================== +============= +VIDEO_GET_PTS +============= Name ---- -VIDEO_SET_DISPLAY_FORMAT +VIDEO_GET_PTS .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT) - :name: VIDEO_SET_DISPLAY_FORMAT +.. c:function:: int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts) + :name: VIDEO_GET_PTS Arguments @@ -45,20 +45,29 @@ Arguments - int request - - Equals VIDEO_SET_DISPLAY_FORMAT for this command. + - Equals VIDEO_GET_PTS for this command. - .. row 3 - - video_display_format_t format + - __u64 \*pts - - Selects the video format to be used. + - Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 / + ISO/IEC 13818-1. + + The PTS should belong to the currently played frame if possible, + but may also be a value close to it like the PTS of the last + decoded frame or the last PTS extracted by the PES parser. Description ----------- -This ioctl call asks the Video Device to select the video format to be -applied by the MPEG chip on the video. +This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders +this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS`` +control. + +This ioctl call asks the Video Device to return the current PTS +timestamp. Return Value diff --git a/Documentation/media/uapi/dvb/audio-set-mute.rst b/Documentation/userspace-api/media/dvb/video-get-size.rst similarity index 58% rename from Documentation/media/uapi/dvb/audio-set-mute.rst rename to Documentation/userspace-api/media/dvb/video-get-size.rst index 4449f225e48c..376745550eb5 100644 --- a/Documentation/media/uapi/dvb/audio-set-mute.rst +++ b/Documentation/userspace-api/media/dvb/video-get-size.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_SET_MUTE: +.. _VIDEO_GET_SIZE: ============== -AUDIO_SET_MUTE +VIDEO_GET_SIZE ============== Name ---- -AUDIO_SET_MUTE +VIDEO_GET_SIZE -.. attention:: This ioctl is deprecated +.. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_SET_MUTE, boolean state) - :name: AUDIO_SET_MUTE +.. c:function:: int ioctl(int fd, VIDEO_GET_SIZE, video_size_t *size) + :name: VIDEO_GET_SIZE Arguments @@ -35,32 +35,39 @@ Arguments :stub-columns: 0 - - + - .. row 1 - int fd - File descriptor returned by a previous call to open(). - - + - .. row 2 - - boolean state + - int request - - Indicates if audio device shall mute or not. + - Equals VIDEO_GET_SIZE for this command. - TRUE: Audio Mute + - .. row 3 - FALSE: Audio Un-mute + - video_size_t \*size + + - Returns the size and aspect ratio. Description ----------- -This ioctl is for Digital TV 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 returns the size and aspect ratio. + +.. c:type:: video_size_t + +.. code-block::c -This ioctl call asks the audio device to mute the stream that is -currently being played. + typedef struct { + int w; + int h; + video_format_t aspect_ratio; + } video_size_t; Return Value diff --git a/Documentation/media/uapi/dvb/video-play.rst b/Documentation/userspace-api/media/dvb/video-get-status.rst similarity index 50% rename from Documentation/media/uapi/dvb/video-play.rst rename to Documentation/userspace-api/media/dvb/video-get-status.rst index fb3f4f168814..d0172593e557 100644 --- a/Documentation/media/uapi/dvb/video-play.rst +++ b/Documentation/userspace-api/media/dvb/video-get-status.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_PLAY: +.. _VIDEO_GET_STATUS: -========== -VIDEO_PLAY -========== +================ +VIDEO_GET_STATUS +================ Name ---- -VIDEO_PLAY +VIDEO_GET_STATUS .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_PLAY) - :name: VIDEO_PLAY +.. c:function:: int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status) + :name: VIDEO_GET_STATUS Arguments @@ -45,18 +45,32 @@ Arguments - int request - - Equals VIDEO_PLAY for this command. + - Equals VIDEO_GET_STATUS for this command. + + - .. row 3 + + - struct video_status \*status + + - Returns the current status of the Video Device. Description ----------- -This ioctl is for Digital TV devices only. To control a V4L2 decoder use the -V4L2 :ref:`VIDIOC_DECODER_CMD` instead. +This ioctl call asks the Video Device to return the current status of +the device. + +.. c:type:: video_status -This ioctl call asks the Video Device to start playing a video stream -from the selected source. +.. code-block:: c + struct video_status { + int video_blank; /* blank video on freeze? */ + video_play_state_t play_state; /* current state of playback */ + video_stream_source_t stream_source; /* current source (demux/memory) */ + video_format_t video_format; /* current aspect ratio of stream*/ + video_displayformat_t display_format;/* selected cropping mode */ + }; Return Value ------------ diff --git a/Documentation/media/uapi/dvb/video-fast-forward.rst b/Documentation/userspace-api/media/dvb/video-play.rst similarity index 58% rename from Documentation/media/uapi/dvb/video-fast-forward.rst rename to Documentation/userspace-api/media/dvb/video-play.rst index 3f805f334ae1..2b6b4e93bd93 100644 --- a/Documentation/media/uapi/dvb/video-fast-forward.rst +++ b/Documentation/userspace-api/media/dvb/video-play.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_FAST_FORWARD: +.. _VIDEO_PLAY: -================== -VIDEO_FAST_FORWARD -================== +========== +VIDEO_PLAY +========== Name ---- -VIDEO_FAST_FORWARD +VIDEO_PLAY .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_FAST_FORWARD, int nFrames) - :name: VIDEO_FAST_FORWARD +.. c:function:: int ioctl(fd, VIDEO_PLAY) + :name: VIDEO_PLAY Arguments @@ -45,21 +45,17 @@ Arguments - int request - - Equals VIDEO_FAST_FORWARD for this command. - - - .. row 3 - - - int nFrames - - - The number of frames to skip. + - Equals VIDEO_PLAY for this command. Description ----------- -This ioctl call asks the Video Device to skip decoding of N number of -I-frames. This call can only be used if VIDEO_SOURCE_MEMORY is -selected. +This ioctl is for Digital TV devices only. To control a V4L2 decoder use the +V4L2 :ref:`VIDIOC_DECODER_CMD` instead. + +This ioctl call asks the Video Device to start playing a video stream +from the selected source. Return Value @@ -68,16 +64,3 @@ Return 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 ` chapter. - - - -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - .. row 1 - - - ``EPERM`` - - - Mode VIDEO_SOURCE_MEMORY not selected. diff --git a/Documentation/media/uapi/dvb/video-select-source.rst b/Documentation/userspace-api/media/dvb/video-select-source.rst similarity index 97% rename from Documentation/media/uapi/dvb/video-select-source.rst rename to Documentation/userspace-api/media/dvb/video-select-source.rst index 32cf025356dc..504f768da00c 100644 --- a/Documentation/media/uapi/dvb/video-select-source.rst +++ b/Documentation/userspace-api/media/dvb/video-select-source.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/video-get-status.rst b/Documentation/userspace-api/media/dvb/video-set-blank.rst similarity index 50% rename from Documentation/media/uapi/dvb/video-get-status.rst rename to Documentation/userspace-api/media/dvb/video-set-blank.rst index 8bfcf8fc3e19..a2608df94d3e 100644 --- a/Documentation/media/uapi/dvb/video-get-status.rst +++ b/Documentation/userspace-api/media/dvb/video-set-blank.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_GET_STATUS: +.. _VIDEO_SET_BLANK: -================ -VIDEO_GET_STATUS -================ +=============== +VIDEO_SET_BLANK +=============== Name ---- -VIDEO_GET_STATUS +VIDEO_SET_BLANK .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_GET_STATUS, struct video_status *status) - :name: VIDEO_GET_STATUS +.. c:function:: int ioctl(fd, VIDEO_SET_BLANK, boolean mode) + :name: VIDEO_SET_BLANK Arguments @@ -45,32 +45,25 @@ Arguments - int request - - Equals VIDEO_GET_STATUS for this command. + - Equals VIDEO_SET_BLANK for this command. - .. row 3 - - struct video_status \*status + - boolean mode - - Returns the current status of the Video Device. + - TRUE: Blank screen when stop. + - .. row 4 -Description ------------ + - + - FALSE: Show last decoded frame. -This ioctl call asks the Video Device to return the current status of -the device. -.. c:type:: video_status +Description +----------- -.. code-block:: c +This ioctl call asks the Video Device to blank out the picture. - struct video_status { - int video_blank; /* blank video on freeze? */ - video_play_state_t play_state; /* current state of playback */ - video_stream_source_t stream_source; /* current source (demux/memory) */ - video_format_t video_format; /* current aspect ratio of stream*/ - video_displayformat_t display_format;/* selected cropping mode */ - }; Return Value ------------ diff --git a/Documentation/media/uapi/dvb/audio-set-bypass-mode.rst b/Documentation/userspace-api/media/dvb/video-set-display-format.rst similarity index 50% rename from Documentation/media/uapi/dvb/audio-set-bypass-mode.rst rename to Documentation/userspace-api/media/dvb/video-set-display-format.rst index d68f05d48d12..c587b3d15e30 100644 --- a/Documentation/media/uapi/dvb/audio-set-bypass-mode.rst +++ b/Documentation/userspace-api/media/dvb/video-set-display-format.rst @@ -3,28 +3,29 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_SET_BYPASS_MODE: +.. _VIDEO_SET_DISPLAY_FORMAT: -===================== -AUDIO_SET_BYPASS_MODE -===================== +======================== +VIDEO_SET_DISPLAY_FORMAT +======================== Name ---- -AUDIO_SET_BYPASS_MODE +VIDEO_SET_DISPLAY_FORMAT -.. attention:: This ioctl is deprecated +.. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_SET_BYPASS_MODE, boolean mode) - :name: AUDIO_SET_BYPASS_MODE +.. c:function:: int ioctl(fd, VIDEO_SET_DISPLAY_FORMAT) + :name: VIDEO_SET_DISPLAY_FORMAT + Arguments --------- @@ -34,32 +35,30 @@ Arguments :stub-columns: 0 - - + - .. row 1 - int fd - File descriptor returned by a previous call to open(). - - + - .. row 2 + + - int request - - boolean mode + - Equals VIDEO_SET_DISPLAY_FORMAT for this command. - - Enables or disables the decoding of the current Audio stream in - the Digital TV subsystem. + - .. row 3 - TRUE: Bypass is disabled + - video_display_format_t format - FALSE: Bypass is enabled + - Selects the video format to be used. 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 Digital TV system shall be decoded. Dolby -DigitalTM streams are automatically forwarded by the Digital TV subsystem if -the hardware can handle it. +This ioctl call asks the Video Device to select the video format to be +applied by the MPEG chip on the video. Return Value diff --git a/Documentation/media/uapi/dvb/video-get-frame-count.rst b/Documentation/userspace-api/media/dvb/video-set-format.rst similarity index 51% rename from Documentation/media/uapi/dvb/video-get-frame-count.rst rename to Documentation/userspace-api/media/dvb/video-set-format.rst index ef35da7d4861..ced74edb74eb 100644 --- a/Documentation/media/uapi/dvb/video-get-frame-count.rst +++ b/Documentation/userspace-api/media/dvb/video-set-format.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_GET_FRAME_COUNT: +.. _VIDEO_SET_FORMAT: -===================== -VIDEO_GET_FRAME_COUNT -===================== +================ +VIDEO_SET_FORMAT +================ Name ---- -VIDEO_GET_FRAME_COUNT +VIDEO_SET_FORMAT .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, VIDEO_GET_FRAME_COUNT, __u64 *pts) - :name: VIDEO_GET_FRAME_COUNT +.. c:function:: int ioctl(fd, VIDEO_SET_FORMAT, video_format_t format) + :name: VIDEO_SET_FORMAT Arguments @@ -45,26 +45,31 @@ Arguments - int request - - Equals VIDEO_GET_FRAME_COUNT for this command. + - Equals VIDEO_SET_FORMAT for this command. - .. row 3 - - __u64 \*pts + - video_format_t format - - Returns the number of frames displayed since the decoder was - started. + - video format of TV as defined in section ??. Description ----------- -This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders -this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_FRAME`` -control. +This ioctl sets the screen format (aspect ratio) of the connected output +device (TV) so that the output of the decoder can be adjusted +accordingly. -This ioctl call asks the Video Device to return the number of displayed -frames since the decoder was started. +.. c:type:: video_format_t +.. code-block:: c + + typedef enum { + VIDEO_FORMAT_4_3, /* Select 4:3 format */ + VIDEO_FORMAT_16_9, /* Select 16:9 format. */ + VIDEO_FORMAT_221_1 /* 2.21:1 */ + } video_format_t; Return Value ------------ @@ -72,3 +77,16 @@ Return 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 ` chapter. + + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + + - .. row 1 + + - ``EINVAL`` + + - format is not a valid video format. diff --git a/Documentation/media/uapi/dvb/audio-stop.rst b/Documentation/userspace-api/media/dvb/video-set-streamtype.rst similarity index 56% rename from Documentation/media/uapi/dvb/audio-stop.rst rename to Documentation/userspace-api/media/dvb/video-set-streamtype.rst index 1bba2e50c364..1729bc04e4f7 100644 --- a/Documentation/media/uapi/dvb/audio-stop.rst +++ b/Documentation/userspace-api/media/dvb/video-set-streamtype.rst @@ -3,28 +3,29 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_STOP: +.. _VIDEO_SET_STREAMTYPE: -========== -AUDIO_STOP -========== +==================== +VIDEO_SET_STREAMTYPE +==================== Name ---- -AUDIO_STOP +VIDEO_SET_STREAMTYPE -.. attention:: This ioctl is deprecated +.. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_STOP) - :name: AUDIO_STOP +.. c:function:: int ioctl(fd, VIDEO_SET_STREAMTYPE, int type) + :name: VIDEO_SET_STREAMTYPE + Arguments --------- @@ -40,12 +41,25 @@ Arguments - File descriptor returned by a previous call to open(). + - .. row 2 + + - int request + + - Equals VIDEO_SET_STREAMTYPE for this command. + + - .. row 3 + + - int type + + - stream type + Description ----------- -This ioctl call asks the Audio Device to stop playing the current -stream. +This ioctl tells the driver which kind of stream to expect being written +to it. If this call is not used the default of video PES is used. Some +drivers might not support this call and always expect PES. Return Value diff --git a/Documentation/media/uapi/dvb/audio-set-av-sync.rst b/Documentation/userspace-api/media/dvb/video-slowmotion.rst similarity index 52% rename from Documentation/media/uapi/dvb/audio-set-av-sync.rst rename to Documentation/userspace-api/media/dvb/video-slowmotion.rst index c116d105fdea..b8cfba7bbfb3 100644 --- a/Documentation/media/uapi/dvb/audio-set-av-sync.rst +++ b/Documentation/userspace-api/media/dvb/video-slowmotion.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _AUDIO_SET_AV_SYNC: +.. _VIDEO_SLOWMOTION: -================= -AUDIO_SET_AV_SYNC -================= +================ +VIDEO_SLOWMOTION +================ Name ---- -AUDIO_SET_AV_SYNC +VIDEO_SLOWMOTION -.. attention:: This ioctl is deprecated +.. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, AUDIO_SET_AV_SYNC, boolean state) - :name: AUDIO_SET_AV_SYNC +.. c:function:: int ioctl(fd, VIDEO_SLOWMOTION, int nFrames) + :name: VIDEO_SLOWMOTION Arguments @@ -35,28 +35,31 @@ Arguments :stub-columns: 0 - - + - .. row 1 - int fd - File descriptor returned by a previous call to open(). - - + - .. row 2 - - boolean state + - int request - - Tells the Digital TV subsystem if A/V synchronization shall be ON or OFF. + - Equals VIDEO_SLOWMOTION for this command. - TRUE: AV-sync ON + - .. row 3 - FALSE: AV-sync OFF + - int nFrames + + - The number of times to repeat each frame. Description ----------- -This ioctl call asks the Audio Device to turn ON or OFF A/V -synchronization. +This ioctl call asks the video device to repeat decoding frames N number +of times. This call can only be used if VIDEO_SOURCE_MEMORY is +selected. Return Value @@ -65,3 +68,16 @@ Return 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 ` chapter. + + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + + - .. row 1 + + - ``EPERM`` + + - Mode VIDEO_SOURCE_MEMORY not selected. diff --git a/Documentation/media/uapi/dvb/video-freeze.rst b/Documentation/userspace-api/media/dvb/video-stillpicture.rst similarity index 55% rename from Documentation/media/uapi/dvb/video-freeze.rst rename to Documentation/userspace-api/media/dvb/video-stillpicture.rst index 6b31a4755d2c..5432619a63a1 100644 --- a/Documentation/media/uapi/dvb/video-freeze.rst +++ b/Documentation/userspace-api/media/dvb/video-stillpicture.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_FREEZE: +.. _VIDEO_STILLPICTURE: -============ -VIDEO_FREEZE -============ +================== +VIDEO_STILLPICTURE +================== Name ---- -VIDEO_FREEZE +VIDEO_STILLPICTURE .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(fd, VIDEO_FREEZE) - :name: VIDEO_FREEZE +.. c:function:: int ioctl(fd, VIDEO_STILLPICTURE, struct video_still_picture *sp) + :name: VIDEO_STILLPICTURE Arguments @@ -45,21 +45,21 @@ Arguments - int request - - Equals VIDEO_FREEZE for this command. + - Equals VIDEO_STILLPICTURE for this command. + + - .. row 3 + + - struct video_still_picture \*sp + + - Pointer to a location where an I-frame and size is stored. Description ----------- -This ioctl is for Digital TV devices only. To control a V4L2 decoder use the -V4L2 :ref:`VIDIOC_DECODER_CMD` instead. - -This ioctl call suspends the live video stream being played. Decoding -and playing are frozen. It is then possible to restart the decoding and -playing process of the video stream using the VIDEO_CONTINUE command. -If VIDEO_SOURCE_MEMORY is selected in the ioctl call -VIDEO_SELECT_SOURCE, the Digital TV subsystem will not decode any more data -until the ioctl call VIDEO_CONTINUE or VIDEO_PLAY is performed. +This ioctl call asks the Video Device to display a still picture +(I-frame). The input data shall contain an I-frame. If the pointer is +NULL, then the current displayed still picture is blanked. Return Value diff --git a/Documentation/media/uapi/dvb/video-get-pts.rst b/Documentation/userspace-api/media/dvb/video-stop.rst similarity index 54% rename from Documentation/media/uapi/dvb/video-get-pts.rst rename to Documentation/userspace-api/media/dvb/video-stop.rst index 86ceefff7834..9a53fe7f2fd0 100644 --- a/Documentation/media/uapi/dvb/video-get-pts.rst +++ b/Documentation/userspace-api/media/dvb/video-stop.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_GET_PTS: +.. _VIDEO_STOP: -============= -VIDEO_GET_PTS -============= +========== +VIDEO_STOP +========== Name ---- -VIDEO_GET_PTS +VIDEO_STOP .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, VIDEO_GET_PTS, __u64 *pts) - :name: VIDEO_GET_PTS +.. c:function:: int ioctl(fd, VIDEO_STOP, boolean mode) + :name: VIDEO_STOP Arguments @@ -45,29 +45,34 @@ Arguments - int request - - Equals VIDEO_GET_PTS for this command. + - Equals VIDEO_STOP for this command. - .. row 3 - - __u64 \*pts + - Boolean mode - - Returns the 33-bit timestamp as defined in ITU T-REC-H.222.0 / - ISO/IEC 13818-1. + - Indicates how the screen shall be handled. - The PTS should belong to the currently played frame if possible, - but may also be a value close to it like the PTS of the last - decoded frame or the last PTS extracted by the PES parser. + - .. row 4 + + - + - TRUE: Blank screen when stop. + + - .. row 5 + + - + - FALSE: Show last decoded frame. Description ----------- -This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders -this ioctl has been replaced by the ``V4L2_CID_MPEG_VIDEO_DEC_PTS`` -control. +This ioctl is for Digital TV devices only. To control a V4L2 decoder use the +V4L2 :ref:`VIDIOC_DECODER_CMD` instead. -This ioctl call asks the Video Device to return the current PTS -timestamp. +This ioctl call asks the Video Device to stop playing the current +stream. Depending on the input parameter, the screen can be blanked out +or displaying the last decoded frame. Return Value diff --git a/Documentation/media/uapi/dvb/video-command.rst b/Documentation/userspace-api/media/dvb/video-try-command.rst similarity index 51% rename from Documentation/media/uapi/dvb/video-command.rst rename to Documentation/userspace-api/media/dvb/video-try-command.rst index 020b49645c6b..61667952030f 100644 --- a/Documentation/media/uapi/dvb/video-command.rst +++ b/Documentation/userspace-api/media/dvb/video-try-command.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _VIDEO_COMMAND: +.. _VIDEO_TRY_COMMAND: -============= -VIDEO_COMMAND -============= +================= +VIDEO_TRY_COMMAND +================= Name ---- -VIDEO_COMMAND +VIDEO_TRY_COMMAND .. attention:: This ioctl is deprecated. Synopsis -------- -.. c:function:: int ioctl(int fd, VIDEO_COMMAND, struct video_command *cmd) - :name: VIDEO_COMMAND +.. c:function:: int ioctl(int fd, VIDEO_TRY_COMMAND, struct video_command *cmd) + :name: VIDEO_TRY_COMMAND Arguments @@ -45,13 +45,13 @@ Arguments - int request - - Equals VIDEO_COMMAND for this command. + - Equals VIDEO_TRY_COMMAND for this command. - .. row 3 - struct video_command \*cmd - - Commands the decoder. + - Try a decoder command. Description @@ -59,42 +59,12 @@ Description This ioctl is obsolete. Do not use in new drivers. For V4L2 decoders this ioctl has been replaced by the -:ref:`VIDIOC_DECODER_CMD` ioctl. +:ref:`VIDIOC_TRY_DECODER_CMD ` ioctl. -This ioctl commands the decoder. The ``video_command`` struct is a +This ioctl tries a decoder command. The ``video_command`` struct is a subset of the ``v4l2_decoder_cmd`` struct, so refer to the -:ref:`VIDIOC_DECODER_CMD` documentation for -more information. - -.. c:type:: struct video_command - -.. code-block:: c - - /* The structure must be zeroed before use by the application - This ensures it can be extended safely in the future. */ - struct video_command { - __u32 cmd; - __u32 flags; - union { - struct { - __u64 pts; - } stop; - - struct { - /* 0 or 1000 specifies normal speed, - 1 specifies forward single stepping, - -1 specifies backward single stepping, - >1: playback at speed/1000 of the normal speed, - <-1: reverse playback at (-speed/1000) of the normal speed. */ - __s32 speed; - __u32 format; - } play; - - struct { - __u32 data[16]; - } raw; - }; - }; +:ref:`VIDIOC_TRY_DECODER_CMD ` documentation +for more information. Return Value diff --git a/Documentation/media/uapi/dvb/video.rst b/Documentation/userspace-api/media/dvb/video.rst similarity index 96% rename from Documentation/media/uapi/dvb/video.rst rename to Documentation/userspace-api/media/dvb/video.rst index 6d72ed0e2b2d..537eae1b0723 100644 --- a/Documentation/media/uapi/dvb/video.rst +++ b/Documentation/userspace-api/media/dvb/video.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/video_function_calls.rst b/Documentation/userspace-api/media/dvb/video_function_calls.rst similarity index 94% rename from Documentation/media/uapi/dvb/video_function_calls.rst rename to Documentation/userspace-api/media/dvb/video_function_calls.rst index 9e8e49e52b19..4902a40d65ba 100644 --- a/Documentation/media/uapi/dvb/video_function_calls.rst +++ b/Documentation/userspace-api/media/dvb/video_function_calls.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/video_types.rst b/Documentation/userspace-api/media/dvb/video_types.rst similarity index 99% rename from Documentation/media/uapi/dvb/video_types.rst rename to Documentation/userspace-api/media/dvb/video_types.rst index 2697400ccf62..bdba1d48f647 100644 --- a/Documentation/media/uapi/dvb/video_types.rst +++ b/Documentation/userspace-api/media/dvb/video_types.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/fdl-appendix.rst b/Documentation/userspace-api/media/fdl-appendix.rst similarity index 99% rename from Documentation/media/uapi/fdl-appendix.rst rename to Documentation/userspace-api/media/fdl-appendix.rst index 9316b8617502..70c8cda10814 100644 --- a/Documentation/media/uapi/fdl-appendix.rst +++ b/Documentation/userspace-api/media/fdl-appendix.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/frontend.h.rst.exceptions b/Documentation/userspace-api/media/frontend.h.rst.exceptions similarity index 100% rename from Documentation/media/frontend.h.rst.exceptions rename to Documentation/userspace-api/media/frontend.h.rst.exceptions diff --git a/Documentation/media/uapi/gen-errors.rst b/Documentation/userspace-api/media/gen-errors.rst similarity index 98% rename from Documentation/media/uapi/gen-errors.rst rename to Documentation/userspace-api/media/gen-errors.rst index 043c312dc06d..abae4dbed549 100644 --- a/Documentation/media/uapi/gen-errors.rst +++ b/Documentation/userspace-api/media/gen-errors.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/media_uapi.rst b/Documentation/userspace-api/media/index.rst similarity index 80% rename from Documentation/media/media_uapi.rst rename to Documentation/userspace-api/media/index.rst index 0753005c7bb4..614310f82395 100644 --- a/Documentation/media/media_uapi.rst +++ b/Documentation/userspace-api/media/index.rst @@ -24,10 +24,10 @@ entitled "GNU Free Documentation License". :maxdepth: 1 intro - uapi/v4l/v4l2 - uapi/dvb/dvbapi - uapi/rc/remote_controllers - uapi/mediactl/media-controller - uapi/cec/cec-api - uapi/gen-errors - uapi/fdl-appendix + v4l/v4l2 + dvb/dvbapi + rc/remote_controllers + mediactl/media-controller + cec/cec-api + gen-errors + fdl-appendix diff --git a/Documentation/media/intro.rst b/Documentation/userspace-api/media/intro.rst similarity index 100% rename from Documentation/media/intro.rst rename to Documentation/userspace-api/media/intro.rst diff --git a/Documentation/media/lirc.h.rst.exceptions b/Documentation/userspace-api/media/lirc.h.rst.exceptions similarity index 100% rename from Documentation/media/lirc.h.rst.exceptions rename to Documentation/userspace-api/media/lirc.h.rst.exceptions diff --git a/Documentation/media/media.h.rst.exceptions b/Documentation/userspace-api/media/media.h.rst.exceptions similarity index 100% rename from Documentation/media/media.h.rst.exceptions rename to Documentation/userspace-api/media/media.h.rst.exceptions diff --git a/Documentation/media/uapi/mediactl/media-controller-intro.rst b/Documentation/userspace-api/media/mediactl/media-controller-intro.rst similarity index 97% rename from Documentation/media/uapi/mediactl/media-controller-intro.rst rename to Documentation/userspace-api/media/mediactl/media-controller-intro.rst index 281c559c2f3c..1d06ea4c4d09 100644 --- a/Documentation/media/uapi/mediactl/media-controller-intro.rst +++ b/Documentation/userspace-api/media/mediactl/media-controller-intro.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-controller-model.rst b/Documentation/userspace-api/media/mediactl/media-controller-model.rst similarity index 97% rename from Documentation/media/uapi/mediactl/media-controller-model.rst rename to Documentation/userspace-api/media/mediactl/media-controller-model.rst index b6d5902b556d..865e73d934d6 100644 --- a/Documentation/media/uapi/mediactl/media-controller-model.rst +++ b/Documentation/userspace-api/media/mediactl/media-controller-model.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-api.rst b/Documentation/userspace-api/media/mediactl/media-controller.rst similarity index 52% rename from Documentation/media/uapi/cec/cec-api.rst rename to Documentation/userspace-api/media/mediactl/media-controller.rst index 0780ba07995a..16bc3ab180d3 100644 --- a/Documentation/media/uapi/cec/cec-api.rst +++ b/Documentation/userspace-api/media/mediactl/media-controller.rst @@ -3,20 +3,17 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections .. include:: -.. _cec: - -######################################### -Part V - Consumer Electronics Control API -######################################### - -This part describes the CEC: Consumer Electronics Control +.. _media_controller: +############################## +Part IV - Media Controller API +############################## .. only:: html @@ -28,27 +25,38 @@ This part describes the CEC: Consumer Electronics Control :maxdepth: 5 :numbered: - cec-intro - cec-funcs - cec-pin-error-inj - cec-header + media-controller-intro + media-controller-model + media-types + request-api + media-funcs + media-header ********************** Revision and Copyright ********************** + Authors: -- Verkuil, Hans +- Pinchart, Laurent - Initial version. -**Copyright** |copy| 2016 : Hans Verkuil +- Carvalho Chehab, Mauro + + - MEDIA_IOC_G_TOPOLOGY documentation and documentation improvements. + +**Copyright** |copy| 2010 : Laurent Pinchart + +**Copyright** |copy| 2015-2016 : Mauro Carvalho Chehab **************** Revision History **************** -:revision: 1.0.0 / 2016-03-17 (*hv*) +:revision: 1.1.0 / 2015-12-12 (*mcc*) + +:revision: 1.0.0 / 2010-11-10 (*lp*) Initial revision diff --git a/Documentation/media/uapi/cec/cec-func-close.rst b/Documentation/userspace-api/media/mediactl/media-func-close.rst similarity index 61% rename from Documentation/media/uapi/cec/cec-func-close.rst rename to Documentation/userspace-api/media/mediactl/media-func-close.rst index e10d675546f8..ceec61c9e7c5 100644 --- a/Documentation/media/uapi/cec/cec-func-close.rst +++ b/Documentation/userspace-api/media/mediactl/media-func-close.rst @@ -3,20 +3,20 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _cec-func-close: +.. _media-func-close: -*********** -cec close() -*********** +************* +media close() +************* Name ==== -cec-close - Close a cec device +media-close - Close a media device Synopsis @@ -28,27 +28,27 @@ Synopsis .. c:function:: int close( int fd ) - :name: cec-close + :name: mc-close Arguments ========= ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by :c:func:`open() `. Description =========== -Closes the cec device. Resources associated with the file descriptor are -freed. The device configuration remain unchanged. +Closes the media device. Resources associated with the file descriptor +are freed. The device configuration remain unchanged. Return Value ============ -:c:func:`close() ` returns 0 on success. On error, -1 is returned, and +:ref:`close() ` returns 0 on success. On error, -1 is returned, and ``errno`` is set appropriately. Possible error codes are: -``EBADF`` +EBADF ``fd`` is not a valid open file descriptor. diff --git a/Documentation/media/uapi/cec/cec-func-ioctl.rst b/Documentation/userspace-api/media/mediactl/media-func-ioctl.rst similarity index 63% rename from Documentation/media/uapi/cec/cec-func-ioctl.rst rename to Documentation/userspace-api/media/mediactl/media-func-ioctl.rst index c18d4ba5eb37..629e7be7c5be 100644 --- a/Documentation/media/uapi/cec/cec-func-ioctl.rst +++ b/Documentation/userspace-api/media/mediactl/media-func-ioctl.rst @@ -3,20 +3,21 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _cec-func-ioctl: +.. _media-func-ioctl: -*********** -cec ioctl() -*********** +************* +media ioctl() +************* Name ==== -cec-ioctl - Control a cec device +media-ioctl - Control a media device + Synopsis ======== @@ -27,17 +28,17 @@ Synopsis .. c:function:: int ioctl( int fd, int request, void *argp ) - :name: cec-ioctl + :name: mc-ioctl Arguments ========= ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by :c:func:`open() `. ``request`` - CEC ioctl request code as defined in the cec.h header file, for - example :ref:`CEC_ADAP_G_CAPS `. + Media ioctl request code as defined in the media.h header file, for + example MEDIA_IOC_SETUP_LINK. ``argp`` Pointer to a request-specific structure. @@ -46,17 +47,17 @@ Arguments Description =========== -The :c:func:`ioctl() ` function manipulates cec device parameters. The -argument ``fd`` must be an open file descriptor. +The :ref:`ioctl() ` function manipulates media device +parameters. The argument ``fd`` must be an open file descriptor. -The ioctl ``request`` code specifies the cec function to be called. It +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 parameter, and the size of the argument ``argp`` in bytes. -Macros and structures definitions specifying cec ioctl requests and -their parameters are located in the cec.h header file. All cec ioctl +Macros and structures definitions specifying media ioctl requests and +their parameters are located in the media.h header file. All media ioctl requests, their respective function and parameters are specified in -:ref:`cec-user-func`. +:ref:`media-user-func`. Return Value diff --git a/Documentation/media/uapi/mediactl/media-func-open.rst b/Documentation/userspace-api/media/mediactl/media-func-open.rst similarity index 96% rename from Documentation/media/uapi/mediactl/media-func-open.rst rename to Documentation/userspace-api/media/mediactl/media-func-open.rst index cd2f840ddf73..4ade1cc5048f 100644 --- a/Documentation/media/uapi/mediactl/media-func-open.rst +++ b/Documentation/userspace-api/media/mediactl/media-func-open.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-funcs.rst b/Documentation/userspace-api/media/mediactl/media-funcs.rst similarity index 93% rename from Documentation/media/uapi/mediactl/media-funcs.rst rename to Documentation/userspace-api/media/mediactl/media-funcs.rst index 87b65df8252a..085e80e7fbd5 100644 --- a/Documentation/media/uapi/mediactl/media-funcs.rst +++ b/Documentation/userspace-api/media/mediactl/media-funcs.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/selection-api-targets.rst b/Documentation/userspace-api/media/mediactl/media-header.rst similarity index 52% rename from Documentation/media/uapi/v4l/selection-api-targets.rst rename to Documentation/userspace-api/media/mediactl/media-header.rst index 83d633bcbd6f..7ff9d24ce65f 100644 --- a/Documentation/media/uapi/v4l/selection-api-targets.rst +++ b/Documentation/userspace-api/media/mediactl/media-header.rst @@ -3,25 +3,15 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -***************** -Selection targets -***************** +.. _media_header: +**************************** +Media Controller Header File +**************************** -.. _sel-targets-capture: +.. kernel-include:: $BUILDDIR/media.h.rst -.. kernel-figure:: selection.svg - :alt: selection.svg - :align: center - - Cropping and composing targets - - Targets used by a cropping, composing and scaling process - - - -See :ref:`v4l2-selection-targets` for more information. diff --git a/Documentation/media/uapi/mediactl/media-ioc-device-info.rst b/Documentation/userspace-api/media/mediactl/media-ioc-device-info.rst similarity index 98% rename from Documentation/media/uapi/mediactl/media-ioc-device-info.rst rename to Documentation/userspace-api/media/mediactl/media-ioc-device-info.rst index f8038cfb708c..9c729bdc8e85 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-device-info.rst +++ b/Documentation/userspace-api/media/mediactl/media-ioc-device-info.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst b/Documentation/userspace-api/media/mediactl/media-ioc-enum-entities.rst similarity index 98% rename from Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst rename to Documentation/userspace-api/media/mediactl/media-ioc-enum-entities.rst index 33e2b110145c..1d01de8e0f97 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst +++ b/Documentation/userspace-api/media/mediactl/media-ioc-enum-entities.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst b/Documentation/userspace-api/media/mediactl/media-ioc-enum-links.rst similarity index 98% rename from Documentation/media/uapi/mediactl/media-ioc-enum-links.rst rename to Documentation/userspace-api/media/mediactl/media-ioc-enum-links.rst index b827ebc398f8..9929b639db97 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-enum-links.rst +++ b/Documentation/userspace-api/media/mediactl/media-ioc-enum-links.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst b/Documentation/userspace-api/media/mediactl/media-ioc-g-topology.rst similarity index 99% rename from Documentation/media/uapi/mediactl/media-ioc-g-topology.rst rename to Documentation/userspace-api/media/mediactl/media-ioc-g-topology.rst index 0a7d76ac8ded..54e3112a3b5a 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-g-topology.rst +++ b/Documentation/userspace-api/media/mediactl/media-ioc-g-topology.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-ioc-request-alloc.rst b/Documentation/userspace-api/media/mediactl/media-ioc-request-alloc.rst similarity index 98% rename from Documentation/media/uapi/mediactl/media-ioc-request-alloc.rst rename to Documentation/userspace-api/media/mediactl/media-ioc-request-alloc.rst index 6d4ca4ada2e0..82f86466c7f2 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-request-alloc.rst +++ b/Documentation/userspace-api/media/mediactl/media-ioc-request-alloc.rst @@ -20,7 +20,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-ioc-setup-link.rst b/Documentation/userspace-api/media/mediactl/media-ioc-setup-link.rst similarity index 97% rename from Documentation/media/uapi/mediactl/media-ioc-setup-link.rst rename to Documentation/userspace-api/media/mediactl/media-ioc-setup-link.rst index ae39dbbe48a0..7da3d0028285 100644 --- a/Documentation/media/uapi/mediactl/media-ioc-setup-link.rst +++ b/Documentation/userspace-api/media/mediactl/media-ioc-setup-link.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-request-ioc-queue.rst b/Documentation/userspace-api/media/mediactl/media-request-ioc-queue.rst similarity index 98% rename from Documentation/media/uapi/mediactl/media-request-ioc-queue.rst rename to Documentation/userspace-api/media/mediactl/media-request-ioc-queue.rst index fc8458746d51..ad55b6b32616 100644 --- a/Documentation/media/uapi/mediactl/media-request-ioc-queue.rst +++ b/Documentation/userspace-api/media/mediactl/media-request-ioc-queue.rst @@ -20,7 +20,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/request-func-ioctl.rst b/Documentation/userspace-api/media/mediactl/media-request-ioc-reinit.rst similarity index 50% rename from Documentation/media/uapi/mediactl/request-func-ioctl.rst rename to Documentation/userspace-api/media/mediactl/media-request-ioc-reinit.rst index de0781c61873..4c43fa05c8f6 100644 --- a/Documentation/media/uapi/mediactl/request-func-ioctl.rst +++ b/Documentation/userspace-api/media/mediactl/media-request-ioc-reinit.rst @@ -20,72 +20,56 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections -.. _request-func-ioctl: +.. _media_request_ioc_reinit: -*************** -request ioctl() -*************** +****************************** +ioctl MEDIA_REQUEST_IOC_REINIT +****************************** Name ==== -request-ioctl - Control a request file descriptor +MEDIA_REQUEST_IOC_REINIT - Re-initialize a request Synopsis ======== -.. code-block:: c +.. c:function:: int ioctl( int request_fd, MEDIA_REQUEST_IOC_REINIT ) + :name: MEDIA_REQUEST_IOC_REINIT - #include - - -.. c:function:: int ioctl( int fd, int cmd, void *argp ) - :name: req-ioctl Arguments ========= -``fd`` +``request_fd`` File descriptor returned by :ref:`MEDIA_IOC_REQUEST_ALLOC`. -``cmd`` - The request ioctl command code as defined in the media.h header file, for - example :ref:`MEDIA_REQUEST_IOC_QUEUE`. - -``argp`` - Pointer to a request-specific structure. - - Description =========== -The :ref:`ioctl() ` function manipulates request -parameters. The argument ``fd`` must be an open file descriptor. - -The ioctl ``cmd`` code specifies the request function to be called. It -has encoded in it whether the argument is an input, output or read/write -parameter, and the size of the argument ``argp`` in bytes. +If the media device supports :ref:`requests `, then +this request ioctl can be used to re-initialize a previously allocated +request. -Macros and structures definitions specifying request ioctl commands and -their parameters are located in the media.h header file. All request ioctl -commands, their respective function and parameters are specified in -:ref:`media-user-func`. +Re-initializing a request will clear any existing data from the request. +This avoids having to :ref:`close() ` a completed +request and allocate a new request. Instead the completed request can just +be re-initialized and it is ready to be used again. +A request can only be re-initialized if it either has not been queued +yet, or if it was queued and completed. Otherwise it will set ``errno`` +to ``EBUSY``. No other error codes can be returned. Return 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 ` chapter. - -Command-specific error codes are listed in the individual command -descriptions. +appropriately. -When an ioctl that takes an output or read/write parameter fails, the -parameter remains unmodified. +EBUSY + The request is queued but not yet completed. diff --git a/Documentation/media/uapi/mediactl/media-types.rst b/Documentation/userspace-api/media/mediactl/media-types.rst similarity index 99% rename from Documentation/media/uapi/mediactl/media-types.rst rename to Documentation/userspace-api/media/mediactl/media-types.rst index 3af6a414b501..77fd4c0c9ebc 100644 --- a/Documentation/media/uapi/mediactl/media-types.rst +++ b/Documentation/userspace-api/media/mediactl/media-types.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/request-api.rst b/Documentation/userspace-api/media/mediactl/request-api.rst similarity index 99% rename from Documentation/media/uapi/mediactl/request-api.rst rename to Documentation/userspace-api/media/mediactl/request-api.rst index 01abe8103bdd..37d9442a541e 100644 --- a/Documentation/media/uapi/mediactl/request-api.rst +++ b/Documentation/userspace-api/media/mediactl/request-api.rst @@ -20,7 +20,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-vivid.rst b/Documentation/userspace-api/media/mediactl/request-func-close.rst similarity index 53% rename from Documentation/media/uapi/v4l/pixfmt-meta-vivid.rst rename to Documentation/userspace-api/media/mediactl/request-func-close.rst index eed20eaefe24..9618b5139764 100644 --- a/Documentation/media/uapi/v4l/pixfmt-meta-vivid.rst +++ b/Documentation/userspace-api/media/mediactl/request-func-close.rst @@ -20,41 +20,54 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections -.. _v4l2-meta-fmt-vivid: +.. _request-func-close: -******************************* -V4L2_META_FMT_VIVID ('VIVD') -******************************* +*************** +request close() +*************** -VIVID Metadata Format +Name +==== + +request-close - Close a request file descriptor + + +Synopsis +======== + +.. code-block:: c + + #include + + +.. c:function:: int close( int fd ) + :name: req-close + +Arguments +========= + +``fd`` + File descriptor returned by :ref:`MEDIA_IOC_REQUEST_ALLOC`. Description =========== -This describes metadata format used by the vivid driver. +Closes the request file descriptor. Resources associated with the request +are freed once all file descriptors associated with the request are closed +and the driver has completed the request. +See :ref:`here ` for more information. -It sets Brightness, Saturation, Contrast and Hue, each of which maps to -corresponding controls of the vivid driver with respect to the range and default values. -It contains the following fields: +Return Value +============ -.. flat-table:: VIVID Metadata - :widths: 1 4 - :header-rows: 1 - :stub-columns: 0 +:ref:`close() ` returns 0 on success. On error, -1 is +returned, and ``errno`` is set appropriately. Possible error codes are: - * - Field - - Description - * - u16 brightness; - - Image brightness, the value is in the range 0 to 255, with the default value as 128. - * - u16 contrast; - - Image contrast, the value is in the range 0 to 255, with the default value as 128. - * - u16 saturation; - - Image color saturation, the value is in the range 0 to 255, with the default value as 128. - * - s16 hue; - - Image color balance, the value is in the range -128 to 128, with the default value as 0. +EBADF + ``fd`` is not a valid open file descriptor. diff --git a/Documentation/media/uapi/mediactl/media-request-ioc-reinit.rst b/Documentation/userspace-api/media/mediactl/request-func-ioctl.rst similarity index 50% rename from Documentation/media/uapi/mediactl/media-request-ioc-reinit.rst rename to Documentation/userspace-api/media/mediactl/request-func-ioctl.rst index 61381e87665a..4bf985205bcc 100644 --- a/Documentation/media/uapi/mediactl/media-request-ioc-reinit.rst +++ b/Documentation/userspace-api/media/mediactl/request-func-ioctl.rst @@ -20,56 +20,72 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections -.. _media_request_ioc_reinit: +.. _request-func-ioctl: -****************************** -ioctl MEDIA_REQUEST_IOC_REINIT -****************************** +*************** +request ioctl() +*************** Name ==== -MEDIA_REQUEST_IOC_REINIT - Re-initialize a request +request-ioctl - Control a request file descriptor Synopsis ======== -.. c:function:: int ioctl( int request_fd, MEDIA_REQUEST_IOC_REINIT ) - :name: MEDIA_REQUEST_IOC_REINIT +.. code-block:: c + #include + + +.. c:function:: int ioctl( int fd, int cmd, void *argp ) + :name: req-ioctl Arguments ========= -``request_fd`` +``fd`` File descriptor returned by :ref:`MEDIA_IOC_REQUEST_ALLOC`. +``cmd`` + The request ioctl command code as defined in the media.h header file, for + example :ref:`MEDIA_REQUEST_IOC_QUEUE`. + +``argp`` + Pointer to a request-specific structure. + + Description =========== -If the media device supports :ref:`requests `, then -this request ioctl can be used to re-initialize a previously allocated -request. +The :ref:`ioctl() ` function manipulates request +parameters. The argument ``fd`` must be an open file descriptor. + +The ioctl ``cmd`` code specifies the request function to be called. It +has encoded in it whether the argument is an input, output or read/write +parameter, and the size of the argument ``argp`` in bytes. -Re-initializing a request will clear any existing data from the request. -This avoids having to :ref:`close() ` a completed -request and allocate a new request. Instead the completed request can just -be re-initialized and it is ready to be used again. +Macros and structures definitions specifying request ioctl commands and +their parameters are located in the media.h header file. All request ioctl +commands, their respective function and parameters are specified in +:ref:`media-user-func`. -A request can only be re-initialized if it either has not been queued -yet, or if it was queued and completed. Otherwise it will set ``errno`` -to ``EBUSY``. No other error codes can be returned. Return Value ============ On success 0 is returned, on error -1 and the ``errno`` variable is set -appropriately. +appropriately. The generic error codes are described at the +:ref:`Generic Error Codes ` chapter. + +Command-specific error codes are listed in the individual command +descriptions. -EBUSY - The request is queued but not yet completed. +When an ioctl that takes an output or read/write parameter fails, the +parameter remains unmodified. diff --git a/Documentation/media/uapi/mediactl/request-func-poll.rst b/Documentation/userspace-api/media/mediactl/request-func-poll.rst similarity index 98% rename from Documentation/media/uapi/mediactl/request-func-poll.rst rename to Documentation/userspace-api/media/mediactl/request-func-poll.rst index ebaf33e21873..85a3427e5913 100644 --- a/Documentation/media/uapi/mediactl/request-func-poll.rst +++ b/Documentation/userspace-api/media/mediactl/request-func-poll.rst @@ -20,7 +20,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/net.h.rst.exceptions b/Documentation/userspace-api/media/net.h.rst.exceptions similarity index 100% rename from Documentation/media/net.h.rst.exceptions rename to Documentation/userspace-api/media/net.h.rst.exceptions diff --git a/Documentation/media/uapi/rc/keytable.c.rst b/Documentation/userspace-api/media/rc/keytable.c.rst similarity index 98% rename from Documentation/media/uapi/rc/keytable.c.rst rename to Documentation/userspace-api/media/rc/keytable.c.rst index 46f98569e999..901d33d37843 100644 --- a/Documentation/media/uapi/rc/keytable.c.rst +++ b/Documentation/userspace-api/media/rc/keytable.c.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-dev-intro.rst b/Documentation/userspace-api/media/rc/lirc-dev-intro.rst similarity index 99% rename from Documentation/media/uapi/rc/lirc-dev-intro.rst rename to Documentation/userspace-api/media/rc/lirc-dev-intro.rst index b68c01693939..0c3d70ded55d 100644 --- a/Documentation/media/uapi/rc/lirc-dev-intro.rst +++ b/Documentation/userspace-api/media/rc/lirc-dev-intro.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-header.rst b/Documentation/userspace-api/media/rc/lirc-dev.rst similarity index 67% rename from Documentation/media/uapi/cec/cec-header.rst rename to Documentation/userspace-api/media/rc/lirc-dev.rst index 726f9766a130..7a395fa52934 100644 --- a/Documentation/media/uapi/cec/cec-header.rst +++ b/Documentation/userspace-api/media/rc/lirc-dev.rst @@ -3,15 +3,19 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _cec_header: +.. _lirc_dev: -*************** -CEC Header File -*************** +LIRC Device Interface +===================== -.. kernel-include:: $BUILDDIR/cec.h.rst +.. toctree:: + :maxdepth: 1 + + lirc-dev-intro + lirc-func + lirc-header diff --git a/Documentation/media/uapi/rc/lirc-func.rst b/Documentation/userspace-api/media/rc/lirc-func.rst similarity index 94% rename from Documentation/media/uapi/rc/lirc-func.rst rename to Documentation/userspace-api/media/rc/lirc-func.rst index 25058369f724..e37c99583212 100644 --- a/Documentation/media/uapi/rc/lirc-func.rst +++ b/Documentation/userspace-api/media/rc/lirc-func.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-get-features.rst b/Documentation/userspace-api/media/rc/lirc-get-features.rst similarity index 98% rename from Documentation/media/uapi/rc/lirc-get-features.rst rename to Documentation/userspace-api/media/rc/lirc-get-features.rst index 1d590df8164a..f4b9ca09f828 100644 --- a/Documentation/media/uapi/rc/lirc-get-features.rst +++ b/Documentation/userspace-api/media/rc/lirc-get-features.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-get-rec-mode.rst b/Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-get-rec-mode.rst rename to Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst index 0a3e02aca80e..674ce16d5d33 100644 --- a/Documentation/media/uapi/rc/lirc-get-rec-mode.rst +++ b/Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-get-rec-resolution.rst b/Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-get-rec-resolution.rst rename to Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst index f560b694ccf2..f20b5bf41232 100644 --- a/Documentation/media/uapi/rc/lirc-get-rec-resolution.rst +++ b/Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-get-send-mode.rst b/Documentation/userspace-api/media/rc/lirc-get-send-mode.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-get-send-mode.rst rename to Documentation/userspace-api/media/rc/lirc-get-send-mode.rst index 4f440c697052..973a47bf6068 100644 --- a/Documentation/media/uapi/rc/lirc-get-send-mode.rst +++ b/Documentation/userspace-api/media/rc/lirc-get-send-mode.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-get-timeout.rst b/Documentation/userspace-api/media/rc/lirc-get-timeout.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-get-timeout.rst rename to Documentation/userspace-api/media/rc/lirc-get-timeout.rst index 1de214529f27..5db84096d7f8 100644 --- a/Documentation/media/uapi/rc/lirc-get-timeout.rst +++ b/Documentation/userspace-api/media/rc/lirc-get-timeout.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/cec/cec-funcs.rst b/Documentation/userspace-api/media/rc/lirc-header.rst similarity index 50% rename from Documentation/media/uapi/cec/cec-funcs.rst rename to Documentation/userspace-api/media/rc/lirc-header.rst index dc6da9c639a8..c7e0716da159 100644 --- a/Documentation/media/uapi/cec/cec-funcs.rst +++ b/Documentation/userspace-api/media/rc/lirc-header.rst @@ -3,28 +3,15 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _cec-user-func: +.. _lirc_header: -****************** -Function Reference -****************** +**************** +LIRC Header File +**************** +.. kernel-include:: $BUILDDIR/lirc.h.rst -.. toctree:: - :maxdepth: 1 - - cec-func-open - cec-func-close - cec-func-ioctl - cec-func-poll - cec-ioc-adap-g-caps - cec-ioc-adap-g-log-addrs - cec-ioc-adap-g-phys-addr - cec-ioc-adap-g-conn-info - cec-ioc-dqevent - cec-ioc-g-mode - cec-ioc-receive diff --git a/Documentation/media/uapi/rc/lirc-read.rst b/Documentation/userspace-api/media/rc/lirc-read.rst similarity index 97% rename from Documentation/media/uapi/rc/lirc-read.rst rename to Documentation/userspace-api/media/rc/lirc-read.rst index 256e520bc27e..13f7f5353851 100644 --- a/Documentation/media/uapi/rc/lirc-read.rst +++ b/Documentation/userspace-api/media/rc/lirc-read.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-set-measure-carrier-mode.rst b/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-set-measure-carrier-mode.rst rename to Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst index c80acd85e369..4cf9472eb904 100644 --- a/Documentation/media/uapi/rc/lirc-set-measure-carrier-mode.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-measure-carrier-mode.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-set-rec-carrier-range.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-set-rec-carrier-range.rst rename to Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst index 443681d5cc10..0439e93aa267 100644 --- a/Documentation/media/uapi/rc/lirc-set-rec-carrier-range.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier-range.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-set-send-carrier.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst similarity index 55% rename from Documentation/media/uapi/rc/lirc-set-send-carrier.rst rename to Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst index cffc6c1e15cc..f4d18897cb9f 100644 --- a/Documentation/media/uapi/rc/lirc-set-send-carrier.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-rec-carrier.rst @@ -3,27 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _lirc_set_send_carrier: +.. _lirc_set_rec_carrier: -*************************** -ioctl LIRC_SET_SEND_CARRIER -*************************** +************************** +ioctl LIRC_SET_REC_CARRIER +************************** Name ==== -LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX. +LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive. Synopsis ======== -.. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency ) - :name: LIRC_SET_SEND_CARRIER +.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER, __u32 *frequency ) + :name: LIRC_SET_REC_CARRIER Arguments ========= @@ -32,12 +32,17 @@ Arguments File descriptor returned by open(). ``frequency`` - Frequency of the carrier to be modulated, in Hz. + Frequency of the carrier that modulates PWM data, in Hz. Description =========== -Set send carrier used to modulate IR PWM pulses and spaces. +Set receive carrier used to modulate IR PWM pulses and spaces. + +.. note:: + + If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl + sets the upper bound frequency that will be recognized by the device. Return Value diff --git a/Documentation/media/uapi/rc/lirc-set-rec-carrier.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst similarity index 51% rename from Documentation/media/uapi/rc/lirc-set-rec-carrier.rst rename to Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst index cbe1e48b2a4a..ab97f87fa757 100644 --- a/Documentation/media/uapi/rc/lirc-set-rec-carrier.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout-reports.rst @@ -3,27 +3,26 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _lirc_set_rec_carrier: +.. _lirc_set_rec_timeout_reports: -************************** -ioctl LIRC_SET_REC_CARRIER -************************** +********************************** +ioctl LIRC_SET_REC_TIMEOUT_REPORTS +********************************** Name ==== -LIRC_SET_REC_CARRIER - Set carrier used to modulate IR receive. - +LIRC_SET_REC_TIMEOUT_REPORTS - enable or disable timeout reports for IR receive Synopsis ======== -.. c:function:: int ioctl( int fd, LIRC_SET_REC_CARRIER, __u32 *frequency ) - :name: LIRC_SET_REC_CARRIER +.. c:function:: int ioctl( int fd, LIRC_SET_REC_TIMEOUT_REPORTS, __u32 *enable ) + :name: LIRC_SET_REC_TIMEOUT_REPORTS Arguments ========= @@ -31,18 +30,22 @@ Arguments ``fd`` File descriptor returned by open(). -``frequency`` - Frequency of the carrier that modulates PWM data, in Hz. +``enable`` + enable = 1 means enable timeout report, enable = 0 means disable timeout + reports. + Description =========== -Set receive carrier used to modulate IR PWM pulses and spaces. +.. _lirc-mode2-timeout: + +Enable or disable timeout reports for IR receive. By default, timeout reports +should be turned off. .. note:: - If called together with :ref:`LIRC_SET_REC_CARRIER_RANGE`, this ioctl - sets the upper bound frequency that will be recognized by the device. + This ioctl is only valid for :ref:`LIRC_MODE_MODE2 `. Return Value diff --git a/Documentation/media/uapi/rc/lirc-set-rec-timeout.rst b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-set-rec-timeout.rst rename to Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst index 163ac6065737..227776cf7c62 100644 --- a/Documentation/media/uapi/rc/lirc-set-rec-timeout.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-rec-timeout.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/frontend_f_close.rst b/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst similarity index 50% rename from Documentation/media/uapi/dvb/frontend_f_close.rst rename to Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst index af87c2a83719..7eaf2b993207 100644 --- a/Documentation/media/uapi/dvb/frontend_f_close.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-send-carrier.rst @@ -3,55 +3,46 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _frontend_f_close: +.. _lirc_set_send_carrier: *************************** -Digital TV frontend close() +ioctl LIRC_SET_SEND_CARRIER *************************** Name ==== -fe-close - Close a frontend device +LIRC_SET_SEND_CARRIER - Set send carrier used to modulate IR TX. Synopsis ======== -.. code-block:: c - - #include - - -.. c:function:: int close( int fd ) - :name: dvb-fe-close +.. c:function:: int ioctl( int fd, LIRC_SET_SEND_CARRIER, __u32 *frequency ) + :name: LIRC_SET_SEND_CARRIER Arguments ========= ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by open(). +``frequency`` + Frequency of the carrier to be modulated, in Hz. Description =========== -This system call closes a previously opened front-end device. After -closing a front-end device, its corresponding hardware might be powered -down automatically. +Set send carrier used to modulate IR PWM pulses and spaces. Return Value ============ -On success 0 is returned. - -On error -1 is returned, and the ``errno`` variable is set -appropriately. - -Generic error codes are described at the +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 ` chapter. diff --git a/Documentation/media/uapi/rc/lirc-set-send-duty-cycle.rst b/Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-set-send-duty-cycle.rst rename to Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst index 08ab3d1a96cd..0dee89364cde 100644 --- a/Documentation/media/uapi/rc/lirc-set-send-duty-cycle.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-send-duty-cycle.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst b/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst similarity index 96% rename from Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst rename to Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst index 889a739eaf0d..dcee4b71dcf6 100644 --- a/Documentation/media/uapi/rc/lirc-set-transmitter-mask.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-transmitter-mask.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst b/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst similarity index 97% rename from Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst rename to Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst index 592715452fce..22f6fe43b7e7 100644 --- a/Documentation/media/uapi/rc/lirc-set-wideband-receiver.rst +++ b/Documentation/userspace-api/media/rc/lirc-set-wideband-receiver.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-write.rst b/Documentation/userspace-api/media/rc/lirc-write.rst similarity index 97% rename from Documentation/media/uapi/rc/lirc-write.rst rename to Documentation/userspace-api/media/rc/lirc-write.rst index eafe13203ea3..96ca4a22062e 100644 --- a/Documentation/media/uapi/rc/lirc-write.rst +++ b/Documentation/userspace-api/media/rc/lirc-write.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/rc-intro.rst b/Documentation/userspace-api/media/rc/rc-intro.rst similarity index 95% rename from Documentation/media/uapi/rc/rc-intro.rst rename to Documentation/userspace-api/media/rc/rc-intro.rst index 37c5f90c76e7..14e85157bf23 100644 --- a/Documentation/media/uapi/rc/rc-intro.rst +++ b/Documentation/userspace-api/media/rc/rc-intro.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/rc-protos.rst b/Documentation/userspace-api/media/rc/rc-protos.rst similarity index 100% rename from Documentation/media/uapi/rc/rc-protos.rst rename to Documentation/userspace-api/media/rc/rc-protos.rst diff --git a/Documentation/media/uapi/rc/rc-sysfs-nodes.rst b/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst similarity index 98% rename from Documentation/media/uapi/rc/rc-sysfs-nodes.rst rename to Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst index b8e8319e3317..73dd75f77d65 100644 --- a/Documentation/media/uapi/rc/rc-sysfs-nodes.rst +++ b/Documentation/userspace-api/media/rc/rc-sysfs-nodes.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/hsv-formats.rst b/Documentation/userspace-api/media/rc/rc-table-change.rst similarity index 50% rename from Documentation/media/uapi/v4l/hsv-formats.rst rename to Documentation/userspace-api/media/rc/rc-table-change.rst index f52f8ba131f0..f5d00a20b939 100644 --- a/Documentation/media/uapi/v4l/hsv-formats.rst +++ b/Documentation/userspace-api/media/rc/rc-table-change.rst @@ -3,24 +3,23 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _hsv-formats: +.. _Remote_controllers_table_change: -*********** -HSV Formats -*********** +******************************************* +Changing default Remote Controller mappings +******************************************* -These formats store the color information of the image -in a geometrical representation. The colors are mapped into a -cylinder, where the angle is the HUE, the height is the VALUE -and the distance to the center is the SATURATION. This is a very -useful format for image segmentation algorithms. +The event interface provides two ioctls to be used against the +/dev/input/event device, to allow changing the default keymapping. + +This program demonstrates how to replace the keymap tables. .. toctree:: :maxdepth: 1 - pixfmt-packed-hsv + keytable.c diff --git a/Documentation/media/uapi/rc/rc-tables.rst b/Documentation/userspace-api/media/rc/rc-tables.rst similarity index 99% rename from Documentation/media/uapi/rc/rc-tables.rst rename to Documentation/userspace-api/media/rc/rc-tables.rst index 20d7c686922b..33b724b17ff3 100644 --- a/Documentation/media/uapi/rc/rc-tables.rst +++ b/Documentation/userspace-api/media/rc/rc-tables.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/remote_controllers.rst b/Documentation/userspace-api/media/rc/remote_controllers.rst similarity index 95% rename from Documentation/media/uapi/rc/remote_controllers.rst rename to Documentation/userspace-api/media/rc/remote_controllers.rst index 20e0f986df49..3ab2d6db1564 100644 --- a/Documentation/media/uapi/rc/remote_controllers.rst +++ b/Documentation/userspace-api/media/rc/remote_controllers.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/typical_media_device.svg b/Documentation/userspace-api/media/typical_media_device.svg similarity index 99% rename from Documentation/media/typical_media_device.svg rename to Documentation/userspace-api/media/typical_media_device.svg index bfd5c7db3b00..3420341ff7b6 100644 --- a/Documentation/media/typical_media_device.svg +++ b/Documentation/userspace-api/media/typical_media_device.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/app-pri.rst b/Documentation/userspace-api/media/v4l/app-pri.rst similarity index 96% rename from Documentation/media/uapi/v4l/app-pri.rst rename to Documentation/userspace-api/media/v4l/app-pri.rst index c25c1271b4f6..5018ede2706f 100644 --- a/Documentation/media/uapi/v4l/app-pri.rst +++ b/Documentation/userspace-api/media/v4l/app-pri.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/net-types.rst b/Documentation/userspace-api/media/v4l/async.rst similarity index 72% rename from Documentation/media/uapi/dvb/net-types.rst rename to Documentation/userspace-api/media/v4l/async.rst index 9e16462a1ef4..8bc4a726c95e 100644 --- a/Documentation/media/uapi/dvb/net-types.rst +++ b/Documentation/userspace-api/media/v4l/async.rst @@ -3,14 +3,14 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _net_types: +.. _async: -************** -Net Data Types -************** +**************** +Asynchronous I/O +**************** -.. kernel-doc:: include/uapi/linux/dvb/net.h +This method is not defined yet. diff --git a/Documentation/media/uapi/v4l/audio.rst b/Documentation/userspace-api/media/v4l/audio.rst similarity index 98% rename from Documentation/media/uapi/v4l/audio.rst rename to Documentation/userspace-api/media/v4l/audio.rst index 4c7fdbc8a860..d6bb85092e02 100644 --- a/Documentation/media/uapi/v4l/audio.rst +++ b/Documentation/userspace-api/media/v4l/audio.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/bayer.svg b/Documentation/userspace-api/media/v4l/bayer.svg similarity index 99% rename from Documentation/media/uapi/v4l/bayer.svg rename to Documentation/userspace-api/media/v4l/bayer.svg index c5bf85103901..82e805c68c1f 100644 --- a/Documentation/media/uapi/v4l/bayer.svg +++ b/Documentation/userspace-api/media/v4l/bayer.svg @@ -22,7 +22,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/biblio.rst b/Documentation/userspace-api/media/v4l/biblio.rst similarity index 99% rename from Documentation/media/uapi/v4l/biblio.rst rename to Documentation/userspace-api/media/v4l/biblio.rst index 8095f57d3d75..3c9634173e82 100644 --- a/Documentation/media/uapi/v4l/biblio.rst +++ b/Documentation/userspace-api/media/v4l/biblio.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/buffer.rst b/Documentation/userspace-api/media/v4l/buffer.rst similarity index 99% rename from Documentation/media/uapi/v4l/buffer.rst rename to Documentation/userspace-api/media/v4l/buffer.rst index 3112300c2fa0..951ae1ed485f 100644 --- a/Documentation/media/uapi/v4l/buffer.rst +++ b/Documentation/userspace-api/media/v4l/buffer.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/lirc-dev.rst b/Documentation/userspace-api/media/v4l/capture-example.rst similarity index 73% rename from Documentation/media/uapi/rc/lirc-dev.rst rename to Documentation/userspace-api/media/v4l/capture-example.rst index 7058e0b2296a..6aa67c5aff8f 100644 --- a/Documentation/media/uapi/rc/lirc-dev.rst +++ b/Documentation/userspace-api/media/v4l/capture-example.rst @@ -3,19 +3,18 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _lirc_dev: +.. _capture-example: -LIRC Device Interface -===================== +********************* +Video Capture Example +********************* .. toctree:: :maxdepth: 1 - lirc-dev-intro - lirc-func - lirc-header + capture.c diff --git a/Documentation/media/uapi/v4l/capture.c.rst b/Documentation/userspace-api/media/v4l/capture.c.rst similarity index 99% rename from Documentation/media/uapi/v4l/capture.c.rst rename to Documentation/userspace-api/media/v4l/capture.c.rst index b4652c2351f2..30f7c816e858 100644 --- a/Documentation/media/uapi/v4l/capture.c.rst +++ b/Documentation/userspace-api/media/v4l/capture.c.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/colorspaces-defs.rst b/Documentation/userspace-api/media/v4l/colorspaces-defs.rst similarity index 99% rename from Documentation/media/uapi/v4l/colorspaces-defs.rst rename to Documentation/userspace-api/media/v4l/colorspaces-defs.rst index e122bbe3d799..01404e1f609a 100644 --- a/Documentation/media/uapi/v4l/colorspaces-defs.rst +++ b/Documentation/userspace-api/media/v4l/colorspaces-defs.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/colorspaces-details.rst b/Documentation/userspace-api/media/v4l/colorspaces-details.rst similarity index 99% rename from Documentation/media/uapi/v4l/colorspaces-details.rst rename to Documentation/userspace-api/media/v4l/colorspaces-details.rst index 8b0ba3668101..79ed6f4f76eb 100644 --- a/Documentation/media/uapi/v4l/colorspaces-details.rst +++ b/Documentation/userspace-api/media/v4l/colorspaces-details.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/colorspaces.rst b/Documentation/userspace-api/media/v4l/colorspaces.rst similarity index 99% rename from Documentation/media/uapi/v4l/colorspaces.rst rename to Documentation/userspace-api/media/v4l/colorspaces.rst index 4f6c82fa057f..0846df9066c5 100644 --- a/Documentation/media/uapi/v4l/colorspaces.rst +++ b/Documentation/userspace-api/media/v4l/colorspaces.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/v4l2grab-example.rst b/Documentation/userspace-api/media/v4l/common-defs.rst similarity index 54% rename from Documentation/media/uapi/v4l/v4l2grab-example.rst rename to Documentation/userspace-api/media/v4l/common-defs.rst index 2a0cfd4429c1..370a1e364a51 100644 --- a/Documentation/media/uapi/v4l/v4l2grab-example.rst +++ b/Documentation/userspace-api/media/v4l/common-defs.rst @@ -3,22 +3,18 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _v4l2grab-example: +.. _common-defs: -********************************** -Video Grabber example using libv4l -********************************** - -This program demonstrates how to grab V4L2 images in ppm format by using -libv4l handlers. The advantage is that this grabber can potentially work -with any V4L2 driver. +****************************************************** +Common definitions for V4L2 and V4L2 subdev interfaces +****************************************************** .. toctree:: :maxdepth: 1 - v4l2grab.c + selections-common diff --git a/Documentation/media/uapi/v4l/common.rst b/Documentation/userspace-api/media/v4l/common.rst similarity index 96% rename from Documentation/media/uapi/v4l/common.rst rename to Documentation/userspace-api/media/v4l/common.rst index 5e87ae24e4b4..af28ac1bcf88 100644 --- a/Documentation/media/uapi/v4l/common.rst +++ b/Documentation/userspace-api/media/v4l/common.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/devices.rst b/Documentation/userspace-api/media/v4l/compat.rst similarity index 59% rename from Documentation/media/uapi/v4l/devices.rst rename to Documentation/userspace-api/media/v4l/compat.rst index 07f8d047662b..055286b86e9b 100644 --- a/Documentation/media/uapi/v4l/devices.rst +++ b/Documentation/userspace-api/media/v4l/compat.rst @@ -3,31 +3,23 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _devices: +.. _compat: -********** -Interfaces -********** +******* +Changes +******* + +The following chapters document the evolution of the V4L2 API, errata or +extensions. They are also intended to help application and driver +writers to port or update their code. .. toctree:: :maxdepth: 1 - dev-capture - dev-overlay - dev-output - dev-osd - dev-mem2mem - dev-raw-vbi - dev-sliced-vbi - dev-radio - dev-rds - dev-sdr - dev-touch - dev-event - dev-subdev - dev-meta + diff-v4l + hist-v4l2 diff --git a/Documentation/media/uapi/v4l/constraints.svg b/Documentation/userspace-api/media/v4l/constraints.svg similarity index 99% rename from Documentation/media/uapi/v4l/constraints.svg rename to Documentation/userspace-api/media/v4l/constraints.svg index 08f9f8b0985e..1dfe51a9839d 100644 --- a/Documentation/media/uapi/v4l/constraints.svg +++ b/Documentation/userspace-api/media/v4l/constraints.svg @@ -22,7 +22,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/control.rst b/Documentation/userspace-api/media/v4l/control.rst similarity index 99% rename from Documentation/media/uapi/v4l/control.rst rename to Documentation/userspace-api/media/v4l/control.rst index ef62e088ff7a..3e991c1f7a12 100644 --- a/Documentation/media/uapi/v4l/control.rst +++ b/Documentation/userspace-api/media/v4l/control.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/crop.rst b/Documentation/userspace-api/media/v4l/crop.rst similarity index 99% rename from Documentation/media/uapi/v4l/crop.rst rename to Documentation/userspace-api/media/v4l/crop.rst index ada7c22e6291..cb7e2341aedf 100644 --- a/Documentation/media/uapi/v4l/crop.rst +++ b/Documentation/userspace-api/media/v4l/crop.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/crop.svg b/Documentation/userspace-api/media/v4l/crop.svg similarity index 99% rename from Documentation/media/uapi/v4l/crop.svg rename to Documentation/userspace-api/media/v4l/crop.svg index 32d72598d135..4cd47f98e7c8 100644 --- a/Documentation/media/uapi/v4l/crop.svg +++ b/Documentation/userspace-api/media/v4l/crop.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/dvb/ca_function_calls.rst b/Documentation/userspace-api/media/v4l/depth-formats.rst similarity index 61% rename from Documentation/media/uapi/dvb/ca_function_calls.rst rename to Documentation/userspace-api/media/v4l/depth-formats.rst index 6985bebd0661..6742486a83b5 100644 --- a/Documentation/media/uapi/dvb/ca_function_calls.rst +++ b/Documentation/userspace-api/media/v4l/depth-formats.rst @@ -3,25 +3,22 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _ca_function_calls: +.. _depth-formats: + +************* +Depth Formats +************* + +Depth data provides distance to points, mapped onto the image plane -***************** -CA Function Calls -***************** .. toctree:: :maxdepth: 1 - ca-fopen - ca-fclose - ca-reset - ca-get-cap - ca-get-slot-info - ca-get-descr-info - ca-get-msg - ca-send-msg - ca-set-descr + pixfmt-inzi + pixfmt-z16 + pixfmt-cnf4 diff --git a/Documentation/media/uapi/v4l/dev-capture.rst b/Documentation/userspace-api/media/v4l/dev-capture.rst similarity index 98% rename from Documentation/media/uapi/v4l/dev-capture.rst rename to Documentation/userspace-api/media/v4l/dev-capture.rst index 134e22b32338..44d3094093ab 100644 --- a/Documentation/media/uapi/v4l/dev-capture.rst +++ b/Documentation/userspace-api/media/v4l/dev-capture.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-decoder.rst b/Documentation/userspace-api/media/v4l/dev-decoder.rst similarity index 100% rename from Documentation/media/uapi/v4l/dev-decoder.rst rename to Documentation/userspace-api/media/v4l/dev-decoder.rst diff --git a/Documentation/media/uapi/v4l/dev-event.rst b/Documentation/userspace-api/media/v4l/dev-event.rst similarity index 97% rename from Documentation/media/uapi/v4l/dev-event.rst rename to Documentation/userspace-api/media/v4l/dev-event.rst index 6029101fe1d7..d09034fd680a 100644 --- a/Documentation/media/uapi/v4l/dev-event.rst +++ b/Documentation/userspace-api/media/v4l/dev-event.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-mem2mem.rst b/Documentation/userspace-api/media/v4l/dev-mem2mem.rst similarity index 97% rename from Documentation/media/uapi/v4l/dev-mem2mem.rst rename to Documentation/userspace-api/media/v4l/dev-mem2mem.rst index 70953958cee6..9279d87c08a1 100644 --- a/Documentation/media/uapi/v4l/dev-mem2mem.rst +++ b/Documentation/userspace-api/media/v4l/dev-mem2mem.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-meta.rst b/Documentation/userspace-api/media/v4l/dev-meta.rst similarity index 98% rename from Documentation/media/uapi/v4l/dev-meta.rst rename to Documentation/userspace-api/media/v4l/dev-meta.rst index c5dbe882be65..6d2c5a79b370 100644 --- a/Documentation/media/uapi/v4l/dev-meta.rst +++ b/Documentation/userspace-api/media/v4l/dev-meta.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-osd.rst b/Documentation/userspace-api/media/v4l/dev-osd.rst similarity index 99% rename from Documentation/media/uapi/v4l/dev-osd.rst rename to Documentation/userspace-api/media/v4l/dev-osd.rst index d3ad67da6386..67dc46373a91 100644 --- a/Documentation/media/uapi/v4l/dev-osd.rst +++ b/Documentation/userspace-api/media/v4l/dev-osd.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-output.rst b/Documentation/userspace-api/media/v4l/dev-output.rst similarity index 98% rename from Documentation/media/uapi/v4l/dev-output.rst rename to Documentation/userspace-api/media/v4l/dev-output.rst index 3fe1b39696ed..e4f2a1d8b0fc 100644 --- a/Documentation/media/uapi/v4l/dev-output.rst +++ b/Documentation/userspace-api/media/v4l/dev-output.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-overlay.rst b/Documentation/userspace-api/media/v4l/dev-overlay.rst similarity index 99% rename from Documentation/media/uapi/v4l/dev-overlay.rst rename to Documentation/userspace-api/media/v4l/dev-overlay.rst index b91b3837d4e7..7246d560173d 100644 --- a/Documentation/media/uapi/v4l/dev-overlay.rst +++ b/Documentation/userspace-api/media/v4l/dev-overlay.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-radio.rst b/Documentation/userspace-api/media/v4l/dev-radio.rst similarity index 97% rename from Documentation/media/uapi/v4l/dev-radio.rst rename to Documentation/userspace-api/media/v4l/dev-radio.rst index 133eb0e788c2..c0edd7b7d201 100644 --- a/Documentation/media/uapi/v4l/dev-radio.rst +++ b/Documentation/userspace-api/media/v4l/dev-radio.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-raw-vbi.rst b/Documentation/userspace-api/media/v4l/dev-raw-vbi.rst similarity index 99% rename from Documentation/media/uapi/v4l/dev-raw-vbi.rst rename to Documentation/userspace-api/media/v4l/dev-raw-vbi.rst index e06b03ca2ab2..0307d44e17cb 100644 --- a/Documentation/media/uapi/v4l/dev-raw-vbi.rst +++ b/Documentation/userspace-api/media/v4l/dev-raw-vbi.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-rds.rst b/Documentation/userspace-api/media/v4l/dev-rds.rst similarity index 99% rename from Documentation/media/uapi/v4l/dev-rds.rst rename to Documentation/userspace-api/media/v4l/dev-rds.rst index 64a724ef58f5..13dba4a4180c 100644 --- a/Documentation/media/uapi/v4l/dev-rds.rst +++ b/Documentation/userspace-api/media/v4l/dev-rds.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-sdr.rst b/Documentation/userspace-api/media/v4l/dev-sdr.rst similarity index 98% rename from Documentation/media/uapi/v4l/dev-sdr.rst rename to Documentation/userspace-api/media/v4l/dev-sdr.rst index 75595c58cb5b..c9563bca444e 100644 --- a/Documentation/media/uapi/v4l/dev-sdr.rst +++ b/Documentation/userspace-api/media/v4l/dev-sdr.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst similarity index 99% rename from Documentation/media/uapi/v4l/dev-sliced-vbi.rst rename to Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst index 7b2d38dd402a..0767299e9105 100644 --- a/Documentation/media/uapi/v4l/dev-sliced-vbi.rst +++ b/Documentation/userspace-api/media/v4l/dev-sliced-vbi.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-stateless-decoder.rst b/Documentation/userspace-api/media/v4l/dev-stateless-decoder.rst similarity index 100% rename from Documentation/media/uapi/v4l/dev-stateless-decoder.rst rename to Documentation/userspace-api/media/v4l/dev-stateless-decoder.rst diff --git a/Documentation/media/uapi/v4l/dev-subdev.rst b/Documentation/userspace-api/media/v4l/dev-subdev.rst similarity index 99% rename from Documentation/media/uapi/v4l/dev-subdev.rst rename to Documentation/userspace-api/media/v4l/dev-subdev.rst index 029bb2d9928a..0c1a5f50ee21 100644 --- a/Documentation/media/uapi/v4l/dev-subdev.rst +++ b/Documentation/userspace-api/media/v4l/dev-subdev.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dev-touch.rst b/Documentation/userspace-api/media/v4l/dev-touch.rst similarity index 97% rename from Documentation/media/uapi/v4l/dev-touch.rst rename to Documentation/userspace-api/media/v4l/dev-touch.rst index 356f01385221..c1ce446274f2 100644 --- a/Documentation/media/uapi/v4l/dev-touch.rst +++ b/Documentation/userspace-api/media/v4l/dev-touch.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/tch-formats.rst b/Documentation/userspace-api/media/v4l/devices.rst similarity index 58% rename from Documentation/media/uapi/v4l/tch-formats.rst rename to Documentation/userspace-api/media/v4l/devices.rst index 429c1010149d..47ffe90753dd 100644 --- a/Documentation/media/uapi/v4l/tch-formats.rst +++ b/Documentation/userspace-api/media/v4l/devices.rst @@ -3,23 +3,31 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _tch-formats: +.. _devices: -************* -Touch Formats -************* - -These formats are used for :ref:`touch` interface only. +********** +Interfaces +********** .. toctree:: :maxdepth: 1 - pixfmt-tch-td16 - pixfmt-tch-td08 - pixfmt-tch-tu16 - pixfmt-tch-tu08 + dev-capture + dev-overlay + dev-output + dev-osd + dev-mem2mem + dev-raw-vbi + dev-sliced-vbi + dev-radio + dev-rds + dev-sdr + dev-touch + dev-event + dev-subdev + dev-meta diff --git a/Documentation/media/uapi/v4l/diff-v4l.rst b/Documentation/userspace-api/media/v4l/diff-v4l.rst similarity index 99% rename from Documentation/media/uapi/v4l/diff-v4l.rst rename to Documentation/userspace-api/media/v4l/diff-v4l.rst index dd6739e8a5b2..37644d26c4ae 100644 --- a/Documentation/media/uapi/v4l/diff-v4l.rst +++ b/Documentation/userspace-api/media/v4l/diff-v4l.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dmabuf.rst b/Documentation/userspace-api/media/v4l/dmabuf.rst similarity index 99% rename from Documentation/media/uapi/v4l/dmabuf.rst rename to Documentation/userspace-api/media/v4l/dmabuf.rst index bb8fd943b14e..342421ff9497 100644 --- a/Documentation/media/uapi/v4l/dmabuf.rst +++ b/Documentation/userspace-api/media/v4l/dmabuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/dv-timings.rst b/Documentation/userspace-api/media/v4l/dv-timings.rst similarity index 97% rename from Documentation/media/uapi/v4l/dv-timings.rst rename to Documentation/userspace-api/media/v4l/dv-timings.rst index b3c69ca559e2..e216aa9edef0 100644 --- a/Documentation/media/uapi/v4l/dv-timings.rst +++ b/Documentation/userspace-api/media/v4l/dv-timings.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-camera.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst similarity index 99% rename from Documentation/media/uapi/v4l/ext-ctrls-camera.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst index 51c1d5c9eb00..e39f84d2447f 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-camera.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-camera.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-codec.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst similarity index 99% rename from Documentation/media/uapi/v4l/ext-ctrls-codec.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst index d4fc5f25aa14..f64f6fc4fd75 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-codec.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-codec.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-detect.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-detect.rst similarity index 97% rename from Documentation/media/uapi/v4l/ext-ctrls-detect.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-detect.rst index 80981d0cff42..77a4992f26bd 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-detect.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-detect.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-dv.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-dv.rst similarity index 99% rename from Documentation/media/uapi/v4l/ext-ctrls-dv.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-dv.rst index 5c70ac98f710..c572b65dc772 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-dv.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-dv.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-flash.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-flash.rst similarity index 99% rename from Documentation/media/uapi/v4l/ext-ctrls-flash.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-flash.rst index b9a6b08fbf32..5053a380f7de 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-flash.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-flash.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-fm-rx.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst similarity index 98% rename from Documentation/media/uapi/v4l/ext-ctrls-fm-rx.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst index 3ed6dd7f586d..69197bbe23dd 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-fm-rx.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-rx.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-fm-tx.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst similarity index 99% rename from Documentation/media/uapi/v4l/ext-ctrls-fm-tx.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst index db88346d99fd..c13ec0a6af3a 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-fm-tx.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-fm-tx.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-image-process.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst similarity index 98% rename from Documentation/media/uapi/v4l/ext-ctrls-image-process.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst index 22fc2d3e433d..e47103aa32ed 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-image-process.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-image-process.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-image-source.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-image-source.rst similarity index 97% rename from Documentation/media/uapi/v4l/ext-ctrls-image-source.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-image-source.rst index 2d3e2b83d6dd..7b75158aca4d 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-image-source.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-image-source.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-jpeg.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-jpeg.rst similarity index 98% rename from Documentation/media/uapi/v4l/ext-ctrls-jpeg.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-jpeg.rst index 60ce3f949319..5ea69978f3ea 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-jpeg.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-jpeg.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/ext-ctrls-rf-tuner.rst b/Documentation/userspace-api/media/v4l/ext-ctrls-rf-tuner.rst similarity index 98% rename from Documentation/media/uapi/v4l/ext-ctrls-rf-tuner.rst rename to Documentation/userspace-api/media/v4l/ext-ctrls-rf-tuner.rst index 0fb85ba878dd..5277138fce67 100644 --- a/Documentation/media/uapi/v4l/ext-ctrls-rf-tuner.rst +++ b/Documentation/userspace-api/media/v4l/ext-ctrls-rf-tuner.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/extended-controls.rst b/Documentation/userspace-api/media/v4l/extended-controls.rst similarity index 99% rename from Documentation/media/uapi/v4l/extended-controls.rst rename to Documentation/userspace-api/media/v4l/extended-controls.rst index 655362483730..9aa352ac5ea4 100644 --- a/Documentation/media/uapi/v4l/extended-controls.rst +++ b/Documentation/userspace-api/media/v4l/extended-controls.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/field-order.rst b/Documentation/userspace-api/media/v4l/field-order.rst similarity index 99% rename from Documentation/media/uapi/v4l/field-order.rst rename to Documentation/userspace-api/media/v4l/field-order.rst index c422bebe4314..04e9a6932dc5 100644 --- a/Documentation/media/uapi/v4l/field-order.rst +++ b/Documentation/userspace-api/media/v4l/field-order.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/fieldseq_tb.svg b/Documentation/userspace-api/media/v4l/fieldseq_bt.svg similarity index 51% rename from Documentation/media/uapi/v4l/fieldseq_tb.svg rename to Documentation/userspace-api/media/v4l/fieldseq_bt.svg index 041071e43f9b..b663f6fcb70b 100644 --- a/Documentation/media/uapi/v4l/fieldseq_tb.svg +++ b/Documentation/userspace-api/media/v4l/fieldseq_bt.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> @@ -17,14 +17,14 @@ xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - id="svg5543" + id="svg3619" version="1.1" inkscape:version="0.91 r13725" xml:space="preserve" width="198.48296mm" - height="210.39415mm" - viewBox="0 0 703.28607 745.49109" - sodipodi:docname="fieldseq_tb.svg">image/svg+xmlV4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_ALTERNATE v4l2_buffer.field:V4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOM + y="-328.99481" + x="10.054964 14.17972 18.766451 20.597849 25.18458 29.771311 34.358047 38.944778 41.238144 43.531509 48.118244 50.865334 53.158699 55.452068 57.283459 61.870193 63.701588 68.288322">v4l2_buffer.field: Temporal order, bottom field first transmitted (e.g. M/NTSC) +Temporal order, top field first transmitted (e.g. BG/PAL)V4L2_FIELD_TOPV4L2_FIELD_TOP +V4L2_FIELD_SEQ_TBV4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_BTV4L2_FIELD_INTERLACED_BT (misaligned)V4L2_FIELD_INTERLACED_TB (misaligned)V4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_TB + y="-86.653496" + x="5.8034 13.806733 20.478176 27.149622 33.821064 40.492508 47.823895 51.159618 59.162952 65.834396 74.497673 81.169121 89.172447 97.175781 106.511 113.18245 121.18579">V4L2_FIELD_SEQ_BT V4L2_FIELD_TOP V4L2_FIELD_BOTTOM V4L2_FIELD_ALTERNATE Temporal order, top field first transmitted (e.g. BG/PAL) -V4L2_FIELD_SEQ_TB + y="-299.23349" + x="5.8034 13.806733 20.478176 27.149622 33.821064 40.492508 47.823895 51.159618 59.162952 65.834396 74.497673 81.169121 84.504837 93.168114 100.4995 108.50284 117.16611 123.83755 131.8409 140.50418 148.50751 157.17079 160.50652 163.84224 167.17796 175.18129 181.85274 188.52419 195.19562 201.86707 209.19846 212.53418 220.53751 227.20895 235.87224 242.54367 245.87939 254.54268 261.87405 269.87741 278.54068 285.21213 293.21545 301.87872 309.88205 318.54535 325.2168 333.22012">V4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_BT V4L2_FIELD_INTERLACED_BT (misaligned) + y="-192.9435" + x="1.5518398 9.5551729 16.226616 22.898062 29.569506 36.240948 43.572334 46.908058 54.911392 61.582836 70.246117 76.917557 80.253281 88.916557 96.247948 104.25128 112.91456 119.586 127.58932 136.25262 144.25595 152.91924 159.59067 166.92206 174.9254 178.26112 182.25679 192.25195 194.91573 200.91524 207.58667 210.25046 212.91423 219.58568 226.25713 232.92856 239.60001">V4L2_FIELD_INTERLACED_TB (misaligned) V4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_TB + y="-86.653496" + x="5.8034 13.806733 20.478176 27.149622 33.821064 40.492508 47.823895 51.159618 59.162952 65.834396 74.497673 81.169121 89.172447 97.175781 106.511 113.18245 121.18579">V4L2_FIELD_SEQ_BT v4l2_buffer.field: + y="-316.23969" + x="103.58983 109.09226 113.67899 118.26572 122.85246 127.43919 132.47964 134.77301 140.27545 144.86218 150.81833 155.40506 160.44553 166.86365 188.62184 194.12427 198.711 203.29774 207.88448 212.47121 217.51166 219.80502 225.30746 229.8942 235.85034 240.43707 245.9395 252.35764 257.3981 262.43854 268.85669 375.69293 381.19534 385.78207 390.3688 394.95554 399.54227 404.58273 406.8761 412.37854 416.96527 422.92142 427.50815 433.01059 439.42871 444.46918 449.50961 455.92776 1.551828 7.0542617 11.640993 16.227724 20.814463 25.401194 30.441652 32.735016 38.237442 42.824177 48.780331 53.367065 58.869492 65.287621 70.328079 75.368538 81.786659">V4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOM V4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOM + y="-328.99481" + x="10.054964 14.17972 18.766451 20.597849 25.18458 29.771311 34.358047 38.944778 41.238144 43.531509 48.118244 50.865334 53.158699 55.452068 57.283459 61.870193 63.701588 68.288322">v4l2_buffer.field: diff --git a/Documentation/media/uapi/v4l/fieldseq_bt.svg b/Documentation/userspace-api/media/v4l/fieldseq_tb.svg similarity index 51% rename from Documentation/media/uapi/v4l/fieldseq_bt.svg rename to Documentation/userspace-api/media/v4l/fieldseq_tb.svg index 1dab1cd1b6de..f8b440a1cb60 100644 --- a/Documentation/media/uapi/v4l/fieldseq_bt.svg +++ b/Documentation/userspace-api/media/v4l/fieldseq_tb.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> @@ -17,14 +17,14 @@ xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - id="svg3619" + id="svg5543" version="1.1" inkscape:version="0.91 r13725" xml:space="preserve" width="198.48296mm" - height="211.89406mm" - viewBox="0 0 703.28606 750.80571" - sodipodi:docname="fieldseq_bt.svg">image/svg+xmlV4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_ALTERNATE V4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOMv4l2_buffer.field:v4l2_buffer.field: + y="-311.9397" + x="10.05469 15.55712 20.143852 24.730585 29.317318 33.904053 38.944508 41.237877 46.740307 51.327042 57.283192 61.869926 66.910378 73.328506 95.0867 100.58913 105.17586 109.7626 114.34933 118.93606 123.97652 126.26987 131.77232 136.35905 142.3152 146.90193 152.40436 158.82249 163.86295 168.9034 175.32153 197.12534 202.62778 207.21451 211.80124 216.38797 220.9747 226.01515 228.30853 233.81096 238.39769 244.35384 248.94058 253.98103 260.39917 282.15695 287.65936 292.24609 296.83282 301.41956 306.00629 311.04675 313.34012 318.84256 323.42929 329.38544 333.97217 339.47461 345.89273 350.9332 355.97363 362.39175 384.19559 389.698 394.28473 398.87149 403.45822 408.04495 413.08539 415.37875 420.8812 425.46793 431.42407 436.0108 441.05127 447.46939 469.2276 474.73001 479.31674 483.90347 488.49023 493.07697 498.1174 500.41077 505.91321 510.49994 516.45612 521.04285 526.54523 532.96338 +538.00385 543.04431 549.4624">V4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOM Temporal order, bottom field first transmitted (e.g. M/NTSC) -V4L2_FIELD_TOPV4L2_FIELD_TOP -Temporal order, top field first transmitted (e.g. BG/PAL)V4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_BTV4L2_FIELD_SEQ_TBV4L2_FIELD_INTERLACED_TB (misaligned)V4L2_FIELD_INTERLACED_BT (misaligned)V4L2_FIELD_SEQ_BT + y="-294.93271" + x="5.8031301 13.806463 20.477907 27.149351 33.820797 40.492241 47.823627 51.159351 59.162685 65.834129 74.497406 81.168854 84.50457 93.167847 100.49924 108.50257 117.16585 123.83729 131.84062 140.50391 148.50723 157.17052 160.50624 163.84196 167.17769 175.18102 181.85246 188.52391 195.19534 201.86679 209.19818 212.53391 220.53723 227.20868 235.87196 242.5434 245.87912 254.5424 261.87378 269.87714 278.54041 285.21185 293.21518 301.87845 309.88177 318.54507 325.21652 332.54791">V4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_TB V4L2_FIELD_TOP V4L2_FIELD_BOTTOM V4L2_FIELD_ALTERNATE Temporal order, top field first transmitted (e.g. BG/PAL) +V4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_BT + y="-86.604706" + x="5.8031301 13.806463 20.477907 27.149351 33.820797 40.492241 47.823627 51.159351 59.162685 65.834129 74.497406 81.168854 89.17218 97.175514 106.51073 113.18218 120.51357">V4L2_FIELD_SEQ_TB V4L2_FIELD_INTERLACED_TB (misaligned) + y="-192.89471" + x="10.05469 18.058023 24.729465 31.400909 38.072357 44.743801 52.075188 55.410912 63.414246 70.085686 78.748962 85.42041 88.756134 97.419411 104.7508 112.75413 121.41741 128.08885 136.09219 144.75546 152.7588 161.42207 168.09352 176.09685 183.42824 186.76396 190.75963 200.75479 203.41858 209.41808 216.08952 218.7533 221.41707 228.08852 234.75996 241.43141 248.10286">V4L2_FIELD_INTERLACED_BT (misaligned) V4L2_FIELD_SEQ_BT + y="-294.93271" + x="5.8031301 13.806463 20.477907 27.149351 33.820797 40.492241 47.823627 51.159351 59.162685 65.834129 74.497406 81.168854 84.50457 93.167847 100.49924 108.50257 117.16585 123.83729 131.84062 140.50391 148.50723 157.17052 160.50624 163.84196 167.17769 175.18102 181.85246 188.52391 195.19534 201.86679 209.19818 212.53391 220.53723 227.20868 235.87196 242.5434 245.87912 254.5424 261.87378 269.87714 278.54041 285.21185 293.21518 301.87845 309.88177 318.54507 325.21652 332.54791">V4L2_FIELD_INTERLACED / V4L2_FIELD_INTERLACED_TB V4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOMV4L2_FIELD_BOTTOM + y="-324.69479" + x="10.05469 14.17945 18.766184 20.597576 25.184309 29.771042 34.357777 38.944508 41.237877 43.531242 48.117977 50.865067 53.158432 55.451801 57.283192 61.869926 63.701321 68.288048">v4l2_buffer.field: v4l2_buffer.field: + y="-311.9397" + x="10.05469 15.55712 20.143852 24.730585 29.317318 33.904053 38.944508 41.237877 46.740307 51.327042 57.283192 61.869926 66.910378 73.328506 95.0867 100.58913 105.17586 109.7626 114.34933 118.93606 123.97652 126.26987 131.77232 136.35905 142.3152 146.90193 152.40436 158.82249 163.86295 168.9034 175.32153 197.12534 202.62778 207.21451 211.80124 216.38797 220.9747 226.01515 228.30853 233.81096 238.39769 244.35384 248.94058 253.98103 260.39917 282.15695 287.65936 292.24609 296.83282 301.41956 306.00629 311.04675 313.34012 318.84256 323.42929 329.38544 333.97217 339.47461 345.89273 350.9332 355.97363 362.39175 384.19559 389.698 394.28473 398.87149 403.45822 408.04495 413.08539 415.37875 420.8812 425.46793 431.42407 436.0108 441.05127 447.46939 469.2276 474.73001 479.31674 483.90347 488.49023 493.07697 498.1174 500.41077 505.91321 510.49994 516.45612 521.04285 526.54523 532.96338 +538.00385 543.04431 549.4624">V4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOMV4L2_FIELD_TOPV4L2_FIELD_BOTTOM diff --git a/Documentation/media/uapi/v4l/format.rst b/Documentation/userspace-api/media/v4l/format.rst similarity index 98% rename from Documentation/media/uapi/v4l/format.rst rename to Documentation/userspace-api/media/v4l/format.rst index 9cdb296333b8..e47fc0505727 100644 --- a/Documentation/media/uapi/v4l/format.rst +++ b/Documentation/userspace-api/media/v4l/format.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/func-close.rst b/Documentation/userspace-api/media/v4l/func-close.rst similarity index 95% rename from Documentation/media/uapi/v4l/func-close.rst rename to Documentation/userspace-api/media/v4l/func-close.rst index 1a56811b827e..37a64dae56b0 100644 --- a/Documentation/media/uapi/v4l/func-close.rst +++ b/Documentation/userspace-api/media/v4l/func-close.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-func-ioctl.rst b/Documentation/userspace-api/media/v4l/func-ioctl.rst similarity index 50% rename from Documentation/media/uapi/mediactl/media-func-ioctl.rst rename to Documentation/userspace-api/media/v4l/func-ioctl.rst index 9a990d6480f5..4e69f303636b 100644 --- a/Documentation/media/uapi/mediactl/media-func-ioctl.rst +++ b/Documentation/userspace-api/media/v4l/func-ioctl.rst @@ -3,20 +3,20 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _media-func-ioctl: +.. _func-ioctl: -************* -media ioctl() -************* +************ +V4L2 ioctl() +************ Name ==== -media-ioctl - Control a media device +v4l2-ioctl - Program a V4L2 device Synopsis @@ -28,36 +28,34 @@ Synopsis .. c:function:: int ioctl( int fd, int request, void *argp ) - :name: mc-ioctl + :name: v4l2-ioctl Arguments ========= ``fd`` - File descriptor returned by :c:func:`open() `. + File descriptor returned by :ref:`open() `. ``request`` - Media ioctl request code as defined in the media.h header file, for - example MEDIA_IOC_SETUP_LINK. + V4L2 ioctl request code as defined in the ``videodev2.h`` header + file, for example VIDIOC_QUERYCAP. ``argp`` - Pointer to a request-specific structure. + Pointer to a function parameter, usually a structure. Description =========== -The :ref:`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 +The :ref:`ioctl() ` function is used to program V4L2 devices. The +argument ``fd`` must be an open file descriptor. An ioctl ``request`` has encoded in it whether the argument is an input, output or read/write -parameter, and the size of the argument ``argp`` in bytes. - -Macros and structures definitions specifying media ioctl requests and -their parameters are located in the media.h header file. All media ioctl -requests, their respective function and parameters are specified in -:ref:`media-user-func`. +parameter, and the size of the argument ``argp`` in bytes. Macros and +defines specifying V4L2 ioctl requests are located in the +``videodev2.h`` header file. Applications should use their own copy, not +include the version in the kernel sources on the system they compile on. +All V4L2 ioctl requests, their respective function and parameters are +specified in :ref:`user-func`. Return Value @@ -67,8 +65,5 @@ 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 ` chapter. -Request-specific error codes are listed in the individual requests -descriptions. - When an ioctl that takes an output or read/write parameter fails, the parameter remains unmodified. diff --git a/Documentation/media/uapi/v4l/func-mmap.rst b/Documentation/userspace-api/media/v4l/func-mmap.rst similarity index 98% rename from Documentation/media/uapi/v4l/func-mmap.rst rename to Documentation/userspace-api/media/v4l/func-mmap.rst index 75985d80788a..f9c77bdce434 100644 --- a/Documentation/media/uapi/v4l/func-mmap.rst +++ b/Documentation/userspace-api/media/v4l/func-mmap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/func-munmap.rst b/Documentation/userspace-api/media/v4l/func-munmap.rst similarity index 96% rename from Documentation/media/uapi/v4l/func-munmap.rst rename to Documentation/userspace-api/media/v4l/func-munmap.rst index 0d472d86a036..18a9941b47ab 100644 --- a/Documentation/media/uapi/v4l/func-munmap.rst +++ b/Documentation/userspace-api/media/v4l/func-munmap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/func-open.rst b/Documentation/userspace-api/media/v4l/func-open.rst similarity index 97% rename from Documentation/media/uapi/v4l/func-open.rst rename to Documentation/userspace-api/media/v4l/func-open.rst index a3d149ce6635..8bcdec8ab387 100644 --- a/Documentation/media/uapi/v4l/func-open.rst +++ b/Documentation/userspace-api/media/v4l/func-open.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/func-poll.rst b/Documentation/userspace-api/media/v4l/func-poll.rst similarity index 98% rename from Documentation/media/uapi/v4l/func-poll.rst rename to Documentation/userspace-api/media/v4l/func-poll.rst index 4c579ed31358..2c6704c1fab7 100644 --- a/Documentation/media/uapi/v4l/func-poll.rst +++ b/Documentation/userspace-api/media/v4l/func-poll.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/func-read.rst b/Documentation/userspace-api/media/v4l/func-read.rst similarity index 98% rename from Documentation/media/uapi/v4l/func-read.rst rename to Documentation/userspace-api/media/v4l/func-read.rst index 14aca4d5e8fd..1728aa5d8313 100644 --- a/Documentation/media/uapi/v4l/func-read.rst +++ b/Documentation/userspace-api/media/v4l/func-read.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/func-select.rst b/Documentation/userspace-api/media/v4l/func-select.rst similarity index 98% rename from Documentation/media/uapi/v4l/func-select.rst rename to Documentation/userspace-api/media/v4l/func-select.rst index af5f1e31c0fb..6aca8a290c1f 100644 --- a/Documentation/media/uapi/v4l/func-select.rst +++ b/Documentation/userspace-api/media/v4l/func-select.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/func-write.rst b/Documentation/userspace-api/media/v4l/func-write.rst similarity index 97% rename from Documentation/media/uapi/v4l/func-write.rst rename to Documentation/userspace-api/media/v4l/func-write.rst index 865129c726ad..fb1955f70f0f 100644 --- a/Documentation/media/uapi/v4l/func-write.rst +++ b/Documentation/userspace-api/media/v4l/func-write.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/hist-v4l2.rst b/Documentation/userspace-api/media/v4l/hist-v4l2.rst similarity index 99% rename from Documentation/media/uapi/v4l/hist-v4l2.rst rename to Documentation/userspace-api/media/v4l/hist-v4l2.rst index 9e097f34cb74..7913d017cd33 100644 --- a/Documentation/media/uapi/v4l/hist-v4l2.rst +++ b/Documentation/userspace-api/media/v4l/hist-v4l2.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/rc/rc-table-change.rst b/Documentation/userspace-api/media/v4l/hsv-formats.rst similarity index 50% rename from Documentation/media/uapi/rc/rc-table-change.rst rename to Documentation/userspace-api/media/v4l/hsv-formats.rst index 4a2e601b89fb..4906f7e0d80d 100644 --- a/Documentation/media/uapi/rc/rc-table-change.rst +++ b/Documentation/userspace-api/media/v4l/hsv-formats.rst @@ -3,23 +3,24 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _Remote_controllers_table_change: +.. _hsv-formats: -******************************************* -Changing default Remote Controller mappings -******************************************* +*********** +HSV Formats +*********** -The event interface provides two ioctls to be used against the -/dev/input/event device, to allow changing the default keymapping. - -This program demonstrates how to replace the keymap tables. +These formats store the color information of the image +in a geometrical representation. The colors are mapped into a +cylinder, where the angle is the HUE, the height is the VALUE +and the distance to the center is the SATURATION. This is a very +useful format for image segmentation algorithms. .. toctree:: :maxdepth: 1 - keytable.c + pixfmt-packed-hsv diff --git a/Documentation/media/uapi/v4l/io.rst b/Documentation/userspace-api/media/v4l/io.rst similarity index 97% rename from Documentation/media/uapi/v4l/io.rst rename to Documentation/userspace-api/media/v4l/io.rst index 049a2530d3a2..de0e2f529268 100644 --- a/Documentation/media/uapi/v4l/io.rst +++ b/Documentation/userspace-api/media/v4l/io.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/libv4l-introduction.rst b/Documentation/userspace-api/media/v4l/libv4l-introduction.rst similarity index 99% rename from Documentation/media/uapi/v4l/libv4l-introduction.rst rename to Documentation/userspace-api/media/v4l/libv4l-introduction.rst index 1b206d380d4b..95f3127b4749 100644 --- a/Documentation/media/uapi/v4l/libv4l-introduction.rst +++ b/Documentation/userspace-api/media/v4l/libv4l-introduction.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/selection-api.rst b/Documentation/userspace-api/media/v4l/libv4l.rst similarity index 56% rename from Documentation/media/uapi/v4l/selection-api.rst rename to Documentation/userspace-api/media/v4l/libv4l.rst index 5386004e87cf..5ea2016cac65 100644 --- a/Documentation/media/uapi/v4l/selection-api.rst +++ b/Documentation/userspace-api/media/v4l/libv4l.rst @@ -3,21 +3,18 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _selection-api: +.. _libv4l: -Cropping, composing and scaling -- the SELECTION API -==================================================== +************************ +Libv4l Userspace Library +************************ .. toctree:: :maxdepth: 1 - selection-api-intro.rst - selection-api-targets.rst - selection-api-configuration.rst - selection-api-vs-crop-api.rst - selection-api-examples.rst + libv4l-introduction diff --git a/Documentation/media/uapi/v4l/meta-formats.rst b/Documentation/userspace-api/media/v4l/meta-formats.rst similarity index 92% rename from Documentation/media/uapi/v4l/meta-formats.rst rename to Documentation/userspace-api/media/v4l/meta-formats.rst index 74c8659ee9d6..7dcc4bacbb0c 100644 --- a/Documentation/media/uapi/v4l/meta-formats.rst +++ b/Documentation/userspace-api/media/v4l/meta-formats.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/mmap.rst b/Documentation/userspace-api/media/v4l/mmap.rst similarity index 99% rename from Documentation/media/uapi/v4l/mmap.rst rename to Documentation/userspace-api/media/v4l/mmap.rst index c47708bf2c87..9c44d05ebc3f 100644 --- a/Documentation/media/uapi/v4l/mmap.rst +++ b/Documentation/userspace-api/media/v4l/mmap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/nv12mt.svg b/Documentation/userspace-api/media/v4l/nv12mt.svg similarity index 99% rename from Documentation/media/uapi/v4l/nv12mt.svg rename to Documentation/userspace-api/media/v4l/nv12mt.svg index 067d8fb34ba2..d4bb4eb83f6a 100644 --- a/Documentation/media/uapi/v4l/nv12mt.svg +++ b/Documentation/userspace-api/media/v4l/nv12mt.svg @@ -22,7 +22,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/nv12mt_example.svg b/Documentation/userspace-api/media/v4l/nv12mt_example.svg similarity index 99% rename from Documentation/media/uapi/v4l/nv12mt_example.svg rename to Documentation/userspace-api/media/v4l/nv12mt_example.svg index 70c3200fdb32..e5075af9f45a 100644 --- a/Documentation/media/uapi/v4l/nv12mt_example.svg +++ b/Documentation/userspace-api/media/v4l/nv12mt_example.svg @@ -22,7 +22,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/open.rst b/Documentation/userspace-api/media/v4l/open.rst similarity index 99% rename from Documentation/media/uapi/v4l/open.rst rename to Documentation/userspace-api/media/v4l/open.rst index 42fad5001c5c..38046ef20141 100644 --- a/Documentation/media/uapi/v4l/open.rst +++ b/Documentation/userspace-api/media/v4l/open.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pipeline.dot b/Documentation/userspace-api/media/v4l/pipeline.dot similarity index 100% rename from Documentation/media/uapi/v4l/pipeline.dot rename to Documentation/userspace-api/media/v4l/pipeline.dot diff --git a/Documentation/media/uapi/v4l/pixfmt-bayer.rst b/Documentation/userspace-api/media/v4l/pixfmt-bayer.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-bayer.rst rename to Documentation/userspace-api/media/v4l/pixfmt-bayer.rst index 807ab34ba93b..be9a8385ebc1 100644 --- a/Documentation/media/uapi/v4l/pixfmt-bayer.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-bayer.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-cnf4.rst b/Documentation/userspace-api/media/v4l/pixfmt-cnf4.rst similarity index 100% rename from Documentation/media/uapi/v4l/pixfmt-cnf4.rst rename to Documentation/userspace-api/media/v4l/pixfmt-cnf4.rst diff --git a/Documentation/media/uapi/v4l/pixfmt-compressed.rst b/Documentation/userspace-api/media/v4l/pixfmt-compressed.rst similarity index 99% rename from Documentation/media/uapi/v4l/pixfmt-compressed.rst rename to Documentation/userspace-api/media/v4l/pixfmt-compressed.rst index 561bda112809..3828bb79225d 100644 --- a/Documentation/media/uapi/v4l/pixfmt-compressed.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-compressed.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-grey.rst b/Documentation/userspace-api/media/v4l/pixfmt-grey.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-grey.rst rename to Documentation/userspace-api/media/v4l/pixfmt-grey.rst index 3a8156164d39..7b03db3393be 100644 --- a/Documentation/media/uapi/v4l/pixfmt-grey.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-grey.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-indexed.rst b/Documentation/userspace-api/media/v4l/pixfmt-indexed.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-indexed.rst rename to Documentation/userspace-api/media/v4l/pixfmt-indexed.rst index 4538b425a046..d0d46ed27260 100644 --- a/Documentation/media/uapi/v4l/pixfmt-indexed.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-indexed.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-intro.rst b/Documentation/userspace-api/media/v4l/pixfmt-intro.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-intro.rst rename to Documentation/userspace-api/media/v4l/pixfmt-intro.rst index ca0a6e0d8959..af870895f653 100644 --- a/Documentation/media/uapi/v4l/pixfmt-intro.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-intro.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-inzi.rst b/Documentation/userspace-api/media/v4l/pixfmt-inzi.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-inzi.rst rename to Documentation/userspace-api/media/v4l/pixfmt-inzi.rst index af2940d844ff..f85cccb71741 100644 --- a/Documentation/media/uapi/v4l/pixfmt-inzi.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-inzi.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-vyuy.rst b/Documentation/userspace-api/media/v4l/pixfmt-m420.rst similarity index 50% rename from Documentation/media/uapi/v4l/pixfmt-vyuy.rst rename to Documentation/userspace-api/media/v4l/pixfmt-m420.rst index 39b99707cd99..5180bbe16c6e 100644 --- a/Documentation/media/uapi/v4l/pixfmt-vyuy.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-m420.rst @@ -3,28 +3,35 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-VYUY: +.. _V4L2-PIX-FMT-M420: ************************** -V4L2_PIX_FMT_VYUY ('VYUY') +V4L2_PIX_FMT_M420 ('M420') ************************** - -Variation of ``V4L2_PIX_FMT_YUYV`` with different order of samples in -memory +Format with ½ horizontal and vertical chroma resolution, also known as +YUV 4:2:0. Hybrid plane line-interleaved layout. Description =========== -In this format each four bytes is two pixels. Each four bytes is two -Y's, a Cb and a Cr. Each Y goes to one of the pixels, and the Cb and Cr -belong to both pixels. As you can see, the Cr and Cb components have -half the horizontal resolution of the Y component. +M420 is a YUV format with ½ horizontal and vertical chroma subsampling +(YUV 4:2:0). Pixels are organized as interleaved luma and chroma planes. +Two lines of luma data are followed by one line of chroma data. + +The luma plane has one byte per pixel. The chroma plane contains +interleaved CbCr pixels subsampled by ½ in the horizontal and vertical +directions. Each CbCr pair belongs to four pixels. For example, +Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`, +Y'\ :sub:`10`, Y'\ :sub:`11`. + +All line lengths are identical: if the Y lines include pad bytes so do +the CbCr lines. **Byte Order.** Each cell is one byte. @@ -35,45 +42,41 @@ Each cell is one byte. :stub-columns: 0 * - start + 0: - - Cr\ :sub:`00` - Y'\ :sub:`00` - - Cb\ :sub:`00` - Y'\ :sub:`01` - - Cr\ :sub:`01` - Y'\ :sub:`02` - - Cb\ :sub:`01` - Y'\ :sub:`03` - * - start + 8: - - Cr\ :sub:`10` + * - start + 4: - Y'\ :sub:`10` - - Cb\ :sub:`10` - Y'\ :sub:`11` - - Cr\ :sub:`11` - Y'\ :sub:`12` - - Cb\ :sub:`11` - Y'\ :sub:`13` + * - start + 8: + - Cb\ :sub:`00` + - Cr\ :sub:`00` + - Cb\ :sub:`01` + - Cr\ :sub:`01` * - start + 16: - - Cr\ :sub:`20` - Y'\ :sub:`20` - - Cb\ :sub:`20` - Y'\ :sub:`21` - - Cr\ :sub:`21` - Y'\ :sub:`22` - - Cb\ :sub:`21` - Y'\ :sub:`23` - * - start + 24: - - Cr\ :sub:`30` + * - start + 20: - Y'\ :sub:`30` - - Cb\ :sub:`30` - Y'\ :sub:`31` - - Cr\ :sub:`31` - Y'\ :sub:`32` - - Cb\ :sub:`31` - Y'\ :sub:`33` + * - start + 24: + - Cb\ :sub:`10` + - Cr\ :sub:`10` + - Cb\ :sub:`11` + - Cr\ :sub:`11` **Color Sample Location:** + + .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -82,34 +85,49 @@ Each cell is one byte. - 0 - - 1 - - - 2 + - - 3 * - 0 - Y - - C + - - Y - Y - - C + - - Y + * - + - + - C + - + - + - C + - * - 1 - Y - - C + - - Y - Y - - C + - - Y + * - * - 2 - Y - - C + - - Y - Y - - C + - - Y + * - + - + - C + - + - + - C + - * - 3 - Y - - C + - - Y - Y - - C + - - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-d4xx.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-d4xx.rst similarity index 99% rename from Documentation/media/uapi/v4l/pixfmt-meta-d4xx.rst rename to Documentation/userspace-api/media/v4l/pixfmt-meta-d4xx.rst index 87e8fd7d5d02..4eaf2f9086a9 100644 --- a/Documentation/media/uapi/v4l/pixfmt-meta-d4xx.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-d4xx.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-intel-ipu3.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-intel-ipu3.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-meta-intel-ipu3.rst rename to Documentation/userspace-api/media/v4l/pixfmt-meta-intel-ipu3.rst index 7fb54339f4a7..97a9a2925671 100644 --- a/Documentation/media/uapi/v4l/pixfmt-meta-intel-ipu3.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-intel-ipu3.rst @@ -19,7 +19,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-uvc.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-uvc.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-meta-uvc.rst rename to Documentation/userspace-api/media/v4l/pixfmt-meta-uvc.rst index 481e4e0e6e1d..debc50285a25 100644 --- a/Documentation/media/uapi/v4l/pixfmt-meta-uvc.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-uvc.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/request-func-close.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-vivid.rst similarity index 53% rename from Documentation/media/uapi/mediactl/request-func-close.rst rename to Documentation/userspace-api/media/v4l/pixfmt-meta-vivid.rst index 2cff7770558e..34a2382ef91c 100644 --- a/Documentation/media/uapi/mediactl/request-func-close.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-vivid.rst @@ -20,54 +20,41 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections -.. _request-func-close: +.. _v4l2-meta-fmt-vivid: -*************** -request close() -*************** +******************************* +V4L2_META_FMT_VIVID ('VIVD') +******************************* -Name -==== - -request-close - Close a request file descriptor - - -Synopsis -======== - -.. code-block:: c - - #include - - -.. c:function:: int close( int fd ) - :name: req-close - -Arguments -========= - -``fd`` - File descriptor returned by :ref:`MEDIA_IOC_REQUEST_ALLOC`. +VIVID Metadata Format Description =========== -Closes the request file descriptor. Resources associated with the request -are freed once all file descriptors associated with the request are closed -and the driver has completed the request. -See :ref:`here ` for more information. +This describes metadata format used by the vivid driver. +It sets Brightness, Saturation, Contrast and Hue, each of which maps to +corresponding controls of the vivid driver with respect to the range and default values. -Return Value -============ +It contains the following fields: -:ref:`close() ` returns 0 on success. On error, -1 is -returned, and ``errno`` is set appropriately. Possible error codes are: +.. flat-table:: VIVID Metadata + :widths: 1 4 + :header-rows: 1 + :stub-columns: 0 -EBADF - ``fd`` is not a valid open file descriptor. + * - Field + - Description + * - u16 brightness; + - Image brightness, the value is in the range 0 to 255, with the default value as 128. + * - u16 contrast; + - Image contrast, the value is in the range 0 to 255, with the default value as 128. + * - u16 saturation; + - Image color saturation, the value is in the range 0 to 255, with the default value as 128. + * - s16 hue; + - Image color balance, the value is in the range -128 to 128, with the default value as 0. diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-vsp1-hgo.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-vsp1-hgo.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-meta-vsp1-hgo.rst rename to Documentation/userspace-api/media/v4l/pixfmt-meta-vsp1-hgo.rst index f7a861696281..b780e447dd4b 100644 --- a/Documentation/media/uapi/v4l/pixfmt-meta-vsp1-hgo.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-vsp1-hgo.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-meta-vsp1-hgt.rst b/Documentation/userspace-api/media/v4l/pixfmt-meta-vsp1-hgt.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-meta-vsp1-hgt.rst rename to Documentation/userspace-api/media/v4l/pixfmt-meta-vsp1-hgt.rst index d1a341af9c48..e165320cc1ff 100644 --- a/Documentation/media/uapi/v4l/pixfmt-meta-vsp1-hgt.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-meta-vsp1-hgt.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-nv16.rst b/Documentation/userspace-api/media/v4l/pixfmt-nv12.rst similarity index 64% rename from Documentation/media/uapi/v4l/pixfmt-nv16.rst rename to Documentation/userspace-api/media/v4l/pixfmt-nv12.rst index 5ec4b7fa8f04..19d47b38e02a 100644 --- a/Documentation/media/uapi/v4l/pixfmt-nv16.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-nv12.rst @@ -3,35 +3,37 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-NV16: -.. _V4L2-PIX-FMT-NV61: +.. _V4L2-PIX-FMT-NV12: +.. _V4L2-PIX-FMT-NV21: ****************************************************** -V4L2_PIX_FMT_NV16 ('NV16'), V4L2_PIX_FMT_NV61 ('NV61') +V4L2_PIX_FMT_NV12 ('NV12'), V4L2_PIX_FMT_NV21 ('NV21') ****************************************************** -V4L2_PIX_FMT_NV61 -Formats with ½ horizontal chroma resolution, also known as YUV 4:2:2. -One luminance and one chrominance plane with alternating chroma samples -as opposed to ``V4L2_PIX_FMT_YVU420`` + +V4L2_PIX_FMT_NV21 +Formats with ½ horizontal and vertical chroma resolution, also known as +YUV 4:2:0. One luminance and one chrominance plane with alternating +chroma samples as opposed to ``V4L2_PIX_FMT_YVU420`` Description =========== -These are two-plane versions of the YUV 4:2:2 format. The three +These are two-plane versions of the YUV 4:2:0 format. The three components are separated into two sub-images or planes. The Y plane is -first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_NV16``, a +first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_NV12``, a combined CbCr plane immediately follows the Y plane in memory. The CbCr -plane is the same width and height, in bytes, as the Y plane (and of the -image). Each CbCr pair belongs to two pixels. For example, -Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`. -``V4L2_PIX_FMT_NV61`` is the same except the Cb and Cr bytes are -swapped, the CrCb plane starts with a Cr byte. +plane is the same width, in bytes, as the Y plane (and of the image), +but is half as tall in pixels. Each CbCr pair belongs to four pixels. +For example, Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, +Y'\ :sub:`01`, Y'\ :sub:`10`, Y'\ :sub:`11`. ``V4L2_PIX_FMT_NV21`` is +the same except the Cb and Cr bytes are swapped, the CrCb plane starts +with a Cr byte. If the Y plane has pad bytes after each row, then the CbCr plane has as many pad bytes after its rows. @@ -74,22 +76,10 @@ Each cell is one byte. - Cr\ :sub:`10` - Cb\ :sub:`11` - Cr\ :sub:`11` - * - start + 24: - - Cb\ :sub:`20` - - Cr\ :sub:`20` - - Cb\ :sub:`21` - - Cr\ :sub:`21` - * - start + 28: - - Cb\ :sub:`30` - - Cr\ :sub:`30` - - Cb\ :sub:`31` - - Cr\ :sub:`31` **Color Sample Location:** - - .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -122,13 +112,6 @@ Each cell is one byte. - Y - - Y - * - - - - - C - - - - - - C - - * - * - 2 - Y @@ -151,10 +134,3 @@ Each cell is one byte. - Y - - Y - * - - - - - C - - - - - - C - - diff --git a/Documentation/media/uapi/v4l/pixfmt-nv12m.rst b/Documentation/userspace-api/media/v4l/pixfmt-nv12m.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-nv12m.rst rename to Documentation/userspace-api/media/v4l/pixfmt-nv12m.rst index 9b2c5c21280a..115ea603c13f 100644 --- a/Documentation/media/uapi/v4l/pixfmt-nv12m.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-nv12m.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-nv12mt.rst b/Documentation/userspace-api/media/v4l/pixfmt-nv12mt.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-nv12mt.rst rename to Documentation/userspace-api/media/v4l/pixfmt-nv12mt.rst index 2092725de33c..daac1c16d4f2 100644 --- a/Documentation/media/uapi/v4l/pixfmt-nv12mt.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-nv12mt.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-nv16m.rst b/Documentation/userspace-api/media/v4l/pixfmt-nv16.rst similarity index 52% rename from Documentation/media/uapi/v4l/pixfmt-nv16m.rst rename to Documentation/userspace-api/media/v4l/pixfmt-nv16.rst index 4a63bcf18b70..977636fc98d6 100644 --- a/Documentation/media/uapi/v4l/pixfmt-nv16m.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-nv16.rst @@ -3,41 +3,38 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-NV16M: -.. _v4l2-pix-fmt-nv61m: +.. _V4L2-PIX-FMT-NV16: +.. _V4L2-PIX-FMT-NV61: -******************************************************** -V4L2_PIX_FMT_NV16M ('NM16'), V4L2_PIX_FMT_NV61M ('NM61') -******************************************************** +****************************************************** +V4L2_PIX_FMT_NV16 ('NV16'), V4L2_PIX_FMT_NV61 ('NV61') +****************************************************** -V4L2_PIX_FMT_NV61M -Variation of ``V4L2_PIX_FMT_NV16`` and ``V4L2_PIX_FMT_NV61`` with planes -non contiguous in memory. +V4L2_PIX_FMT_NV61 +Formats with ½ horizontal chroma resolution, also known as YUV 4:2:2. +One luminance and one chrominance plane with alternating chroma samples +as opposed to ``V4L2_PIX_FMT_YVU420`` Description =========== -This is a multi-planar, two-plane version of the YUV 4:2:2 format. The -three components are separated into two sub-images or planes. -``V4L2_PIX_FMT_NV16M`` differs from ``V4L2_PIX_FMT_NV16`` in that the -two planes are non-contiguous in memory, i.e. the chroma plane does not -necessarily immediately follow the luma plane. The luminance data -occupies the first plane. The Y plane has one byte per pixel. In the -second plane there is chrominance data with alternating chroma samples. -The CbCr plane is the same width and height, in bytes, as the Y plane. -Each CbCr pair belongs to two pixels. For example, +These are two-plane versions of the YUV 4:2:2 format. The three +components are separated into two sub-images or planes. The Y plane is +first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_NV16``, a +combined CbCr plane immediately follows the Y plane in memory. The CbCr +plane is the same width and height, in bytes, as the Y plane (and of the +image). Each CbCr pair belongs to two pixels. For example, Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`. -``V4L2_PIX_FMT_NV61M`` is the same as ``V4L2_PIX_FMT_NV16M`` except the -Cb and Cr bytes are swapped, the CrCb plane starts with a Cr byte. +``V4L2_PIX_FMT_NV61`` is the same except the Cb and Cr bytes are +swapped, the CrCb plane starts with a Cr byte. -``V4L2_PIX_FMT_NV16M`` and ``V4L2_PIX_FMT_NV61M`` are intended to be -used only in drivers and applications that support the multi-planar API, -described in :ref:`planar-apis`. +If the Y plane has pad bytes after each row, then the CbCr plane has as +many pad bytes after its rows. **Byte Order.** Each cell is one byte. @@ -47,47 +44,46 @@ Each cell is one byte. :header-rows: 0 :stub-columns: 0 - * - start0 + 0: + * - start + 0: - Y'\ :sub:`00` - Y'\ :sub:`01` - Y'\ :sub:`02` - Y'\ :sub:`03` - * - start0 + 4: + * - start + 4: - Y'\ :sub:`10` - Y'\ :sub:`11` - Y'\ :sub:`12` - Y'\ :sub:`13` - * - start0 + 8: + * - start + 8: - Y'\ :sub:`20` - Y'\ :sub:`21` - Y'\ :sub:`22` - Y'\ :sub:`23` - * - start0 + 12: + * - start + 12: - Y'\ :sub:`30` - Y'\ :sub:`31` - Y'\ :sub:`32` - Y'\ :sub:`33` - * - - * - start1 + 0: + * - start + 16: - Cb\ :sub:`00` - Cr\ :sub:`00` - - Cb\ :sub:`02` - - Cr\ :sub:`02` - * - start1 + 4: + - Cb\ :sub:`01` + - Cr\ :sub:`01` + * - start + 20: - Cb\ :sub:`10` - Cr\ :sub:`10` - - Cb\ :sub:`12` - - Cr\ :sub:`12` - * - start1 + 8: + - Cb\ :sub:`11` + - Cr\ :sub:`11` + * - start + 24: - Cb\ :sub:`20` - Cr\ :sub:`20` - - Cb\ :sub:`22` - - Cr\ :sub:`22` - * - start1 + 12: + - Cb\ :sub:`21` + - Cr\ :sub:`21` + * - start + 28: - Cb\ :sub:`30` - Cr\ :sub:`30` - - Cb\ :sub:`32` - - Cr\ :sub:`32` + - Cb\ :sub:`31` + - Cr\ :sub:`31` **Color Sample Location:** diff --git a/Documentation/userspace-api/media/v4l/pixfmt-nv16m.rst b/Documentation/userspace-api/media/v4l/pixfmt-nv16m.rst new file mode 100644 index 000000000000..cf33942d942d --- /dev/null +++ b/Documentation/userspace-api/media/v4l/pixfmt-nv16m.rst @@ -0,0 +1,164 @@ +.. Permission is granted to copy, distribute and/or modify this +.. document under the terms of the GNU Free Documentation License, +.. Version 1.1 or any later version published by the Free Software +.. Foundation, with no Invariant Sections, no Front-Cover Texts +.. and no Back-Cover Texts. A copy of the license is included at +.. Documentation/userspace-api/media/fdl-appendix.rst. +.. +.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections + +.. _V4L2-PIX-FMT-NV16M: +.. _v4l2-pix-fmt-nv61m: + +******************************************************** +V4L2_PIX_FMT_NV16M ('NM16'), V4L2_PIX_FMT_NV61M ('NM61') +******************************************************** + +V4L2_PIX_FMT_NV61M +Variation of ``V4L2_PIX_FMT_NV16`` and ``V4L2_PIX_FMT_NV61`` with planes +non contiguous in memory. + + +Description +=========== + +This is a multi-planar, two-plane version of the YUV 4:2:2 format. The +three components are separated into two sub-images or planes. +``V4L2_PIX_FMT_NV16M`` differs from ``V4L2_PIX_FMT_NV16`` in that the +two planes are non-contiguous in memory, i.e. the chroma plane does not +necessarily immediately follow the luma plane. The luminance data +occupies the first plane. The Y plane has one byte per pixel. In the +second plane there is chrominance data with alternating chroma samples. +The CbCr plane is the same width and height, in bytes, as the Y plane. +Each CbCr pair belongs to two pixels. For example, +Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`. +``V4L2_PIX_FMT_NV61M`` is the same as ``V4L2_PIX_FMT_NV16M`` except the +Cb and Cr bytes are swapped, the CrCb plane starts with a Cr byte. + +``V4L2_PIX_FMT_NV16M`` and ``V4L2_PIX_FMT_NV61M`` are intended to be +used only in drivers and applications that support the multi-planar API, +described in :ref:`planar-apis`. + +**Byte Order.** +Each cell is one byte. + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - start0 + 0: + - Y'\ :sub:`00` + - Y'\ :sub:`01` + - Y'\ :sub:`02` + - Y'\ :sub:`03` + * - start0 + 4: + - Y'\ :sub:`10` + - Y'\ :sub:`11` + - Y'\ :sub:`12` + - Y'\ :sub:`13` + * - start0 + 8: + - Y'\ :sub:`20` + - Y'\ :sub:`21` + - Y'\ :sub:`22` + - Y'\ :sub:`23` + * - start0 + 12: + - Y'\ :sub:`30` + - Y'\ :sub:`31` + - Y'\ :sub:`32` + - Y'\ :sub:`33` + * - + * - start1 + 0: + - Cb\ :sub:`00` + - Cr\ :sub:`00` + - Cb\ :sub:`02` + - Cr\ :sub:`02` + * - start1 + 4: + - Cb\ :sub:`10` + - Cr\ :sub:`10` + - Cb\ :sub:`12` + - Cr\ :sub:`12` + * - start1 + 8: + - Cb\ :sub:`20` + - Cr\ :sub:`20` + - Cb\ :sub:`22` + - Cr\ :sub:`22` + * - start1 + 12: + - Cb\ :sub:`30` + - Cr\ :sub:`30` + - Cb\ :sub:`32` + - Cr\ :sub:`32` + + +**Color Sample Location:** + + + +.. flat-table:: + :header-rows: 0 + :stub-columns: 0 + + * - + - 0 + - + - 1 + - 2 + - + - 3 + * - 0 + - Y + - + - Y + - Y + - + - Y + * - + - + - C + - + - + - C + - + * - 1 + - Y + - + - Y + - Y + - + - Y + * - + - + - C + - + - + - C + - + * - + * - 2 + - Y + - + - Y + - Y + - + - Y + * - + - + - C + - + - + - C + - + * - 3 + - Y + - + - Y + - Y + - + - Y + * - + - + - C + - + - + - C + - diff --git a/Documentation/media/uapi/v4l/pixfmt-nv24.rst b/Documentation/userspace-api/media/v4l/pixfmt-nv24.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-nv24.rst rename to Documentation/userspace-api/media/v4l/pixfmt-nv24.rst index 13fc6fe1a3d6..c6fb97bd0472 100644 --- a/Documentation/media/uapi/v4l/pixfmt-nv24.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-nv24.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-packed-hsv.rst b/Documentation/userspace-api/media/v4l/pixfmt-packed-hsv.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-packed-hsv.rst rename to Documentation/userspace-api/media/v4l/pixfmt-packed-hsv.rst index dfc4a8367b3d..b8c9b0225eea 100644 --- a/Documentation/media/uapi/v4l/pixfmt-packed-hsv.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-packed-hsv.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-packed-yuv.rst b/Documentation/userspace-api/media/v4l/pixfmt-packed-yuv.rst similarity index 99% rename from Documentation/media/uapi/v4l/pixfmt-packed-yuv.rst rename to Documentation/userspace-api/media/v4l/pixfmt-packed-yuv.rst index 41b60fae703a..bbd4bd094deb 100644 --- a/Documentation/media/uapi/v4l/pixfmt-packed-yuv.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-packed-yuv.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-reserved.rst b/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst similarity index 99% rename from Documentation/media/uapi/v4l/pixfmt-reserved.rst rename to Documentation/userspace-api/media/v4l/pixfmt-reserved.rst index 7d98a7bf9f1f..8ef90b0df864 100644 --- a/Documentation/media/uapi/v4l/pixfmt-reserved.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-reserved.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-rgb.rst b/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst similarity index 99% rename from Documentation/media/uapi/v4l/pixfmt-rgb.rst rename to Documentation/userspace-api/media/v4l/pixfmt-rgb.rst index 4ce305cc45da..b6c0c942d9d1 100644 --- a/Documentation/media/uapi/v4l/pixfmt-rgb.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-rgb.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-ru12le.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cs08.rst similarity index 53% rename from Documentation/media/uapi/v4l/pixfmt-sdr-ru12le.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-cs08.rst index 3c2c9f75fc5e..13f3908d162a 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-ru12le.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cs08.rst @@ -3,37 +3,35 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-SDR-FMT-RU12LE: +.. _v4l2-sdr-fmt-cs8: -**************************** -V4L2_SDR_FMT_RU12LE ('RU12') -**************************** +************************* +V4L2_SDR_FMT_CS8 ('CS08') +************************* - -Real unsigned 12-bit little endian sample +Complex signed 8-bit IQ sample Description =========== -This format contains sequence of real number samples. Each sample is -represented as a 12 bit unsigned little endian number. Sample is stored -in 16 bit space with unused high bits padded with 0. +This format contains sequence of complex number samples. Each complex +number consist two parts, called In-phase and Quadrature (IQ). Both I +and Q are represented as a 8 bit signed number. I value comes first and +Q value after that. **Byte Order.** Each cell is one byte. - - - .. flat-table:: :header-rows: 0 :stub-columns: 0 * - start + 0: - - I'\ :sub:`0[7:0]` - - I'\ :sub:`0[11:8]` + - I'\ :sub:`0` + * - start + 1: + - Q'\ :sub:`0` diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-cs14le.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cs14le.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-sdr-cs14le.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-cs14le.rst index d10d56f0e63a..41e5b990d499 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-cs14le.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cs14le.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-cu16le.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cu08.rst similarity index 60% rename from Documentation/media/uapi/v4l/pixfmt-sdr-cu16le.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-cu08.rst index 237998fb5f9f..1085b5ad8eb7 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-cu16le.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cu08.rst @@ -3,18 +3,17 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-SDR-FMT-CU16LE: +.. _v4l2-sdr-fmt-cu8: -**************************** -V4L2_SDR_FMT_CU16LE ('CU16') -**************************** +************************* +V4L2_SDR_FMT_CU8 ('CU08') +************************* - -Complex unsigned 16-bit little endian IQ sample +Complex unsigned 8-bit IQ sample Description @@ -22,20 +21,17 @@ Description This format contains sequence of complex number samples. Each complex number consist two parts, called In-phase and Quadrature (IQ). Both I -and Q are represented as a 16 bit unsigned little endian number. I value -comes first and Q value after that. +and Q are represented as a 8 bit unsigned number. I value comes first +and Q value after that. **Byte Order.** Each cell is one byte. - .. flat-table:: :header-rows: 0 :stub-columns: 0 * - start + 0: - - I'\ :sub:`0[7:0]` - - I'\ :sub:`0[15:8]` - * - start + 2: - - Q'\ :sub:`0[7:0]` - - Q'\ :sub:`0[15:8]` + - I'\ :sub:`0` + * - start + 1: + - Q'\ :sub:`0` diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-cs08.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cu16le.rst similarity index 60% rename from Documentation/media/uapi/v4l/pixfmt-sdr-cs08.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-cu16le.rst index e7a89fe7e117..9772b30bda95 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-cs08.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-cu16le.rst @@ -3,17 +3,18 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _v4l2-sdr-fmt-cs8: +.. _V4L2-SDR-FMT-CU16LE: -************************* -V4L2_SDR_FMT_CS8 ('CS08') -************************* +**************************** +V4L2_SDR_FMT_CU16LE ('CU16') +**************************** -Complex signed 8-bit IQ sample + +Complex unsigned 16-bit little endian IQ sample Description @@ -21,17 +22,20 @@ Description This format contains sequence of complex number samples. Each complex number consist two parts, called In-phase and Quadrature (IQ). Both I -and Q are represented as a 8 bit signed number. I value comes first and -Q value after that. +and Q are represented as a 16 bit unsigned little endian number. I value +comes first and Q value after that. **Byte Order.** Each cell is one byte. + .. flat-table:: :header-rows: 0 :stub-columns: 0 * - start + 0: - - I'\ :sub:`0` - * - start + 1: - - Q'\ :sub:`0` + - I'\ :sub:`0[7:0]` + - I'\ :sub:`0[15:8]` + * - start + 2: + - Q'\ :sub:`0[7:0]` + - Q'\ :sub:`0[15:8]` diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-pcu20be.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu16be.rst similarity index 63% rename from Documentation/media/uapi/v4l/pixfmt-sdr-pcu20be.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu16be.rst index 11a05ea60e26..53a0a862f33a 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-pcu20be.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu16be.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-SDR-FMT-PCU20BE: +.. _V4L2-SDR-FMT-PCU16BE: ****************************** -V4L2_SDR_FMT_PCU20BE ('PC20') +V4L2_SDR_FMT_PCU16BE ('PC16') ****************************** -Planar complex unsigned 20-bit big endian IQ sample +Planar complex unsigned 16-bit big endian IQ sample Description =========== This format contains a sequence of complex number samples. Each complex number consist of two parts called In-phase and Quadrature (IQ). Both I -and Q are represented as a 20 bit unsigned big endian number stored in +and Q are represented as a 16 bit unsigned big endian number stored in 32 bit space. The remaining unused bits within the 32 bit space will be padded with 0. I value starts first and Q value starts at an offset equalling half of the buffer size (i.e.) offset = buffersize/2. Out of -the 20 bits, bit 19:2 (18 bit) is data and bit 1:0 (2 bit) can be any +the 16 bits, bit 15:2 (14 bit) is data and bit 1:0 (2 bit) can be any value. **Byte Order.** @@ -40,23 +40,23 @@ Each cell is one byte. - Byte B2 - Byte B3 * - start + 0: - - I'\ :sub:`0[19:12]` - - I'\ :sub:`0[11:4]` - - I'\ :sub:`0[3:0]; B2[3:0]=pad` + - I'\ :sub:`0[13:6]` + - I'\ :sub:`0[5:0]; B1[1:0]=pad` + - pad - pad * - start + 4: - - I'\ :sub:`1[19:12]` - - I'\ :sub:`1[11:4]` - - I'\ :sub:`1[3:0]; B2[3:0]=pad` + - I'\ :sub:`1[13:6]` + - I'\ :sub:`1[5:0]; B1[1:0]=pad` + - pad - pad * - ... * - start + offset: - - Q'\ :sub:`0[19:12]` - - Q'\ :sub:`0[11:4]` - - Q'\ :sub:`0[3:0]; B2[3:0]=pad` + - Q'\ :sub:`0[13:6]` + - Q'\ :sub:`0[5:0]; B1[1:0]=pad` + - pad - pad * - start + offset + 4: - - Q'\ :sub:`1[19:12]` - - Q'\ :sub:`1[11:4]` - - Q'\ :sub:`1[3:0]; B2[3:0]=pad` + - Q'\ :sub:`1[13:6]` + - Q'\ :sub:`1[5:0]; B1[1:0]=pad` + - pad - pad diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-pcu18be.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu18be.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-sdr-pcu18be.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu18be.rst index a1ea63db9230..7f2d2545fb04 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-pcu18be.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu18be.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-pcu16be.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu20be.rst similarity index 63% rename from Documentation/media/uapi/v4l/pixfmt-sdr-pcu16be.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu20be.rst index df078dcfd18d..9f3d67b4e94c 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-pcu16be.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-pcu20be.rst @@ -3,28 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-SDR-FMT-PCU16BE: +.. _V4L2-SDR-FMT-PCU20BE: ****************************** -V4L2_SDR_FMT_PCU16BE ('PC16') +V4L2_SDR_FMT_PCU20BE ('PC20') ****************************** -Planar complex unsigned 16-bit big endian IQ sample +Planar complex unsigned 20-bit big endian IQ sample Description =========== This format contains a sequence of complex number samples. Each complex number consist of two parts called In-phase and Quadrature (IQ). Both I -and Q are represented as a 16 bit unsigned big endian number stored in +and Q are represented as a 20 bit unsigned big endian number stored in 32 bit space. The remaining unused bits within the 32 bit space will be padded with 0. I value starts first and Q value starts at an offset equalling half of the buffer size (i.e.) offset = buffersize/2. Out of -the 16 bits, bit 15:2 (14 bit) is data and bit 1:0 (2 bit) can be any +the 20 bits, bit 19:2 (18 bit) is data and bit 1:0 (2 bit) can be any value. **Byte Order.** @@ -40,23 +40,23 @@ Each cell is one byte. - Byte B2 - Byte B3 * - start + 0: - - I'\ :sub:`0[13:6]` - - I'\ :sub:`0[5:0]; B1[1:0]=pad` - - pad + - I'\ :sub:`0[19:12]` + - I'\ :sub:`0[11:4]` + - I'\ :sub:`0[3:0]; B2[3:0]=pad` - pad * - start + 4: - - I'\ :sub:`1[13:6]` - - I'\ :sub:`1[5:0]; B1[1:0]=pad` - - pad + - I'\ :sub:`1[19:12]` + - I'\ :sub:`1[11:4]` + - I'\ :sub:`1[3:0]; B2[3:0]=pad` - pad * - ... * - start + offset: - - Q'\ :sub:`0[13:6]` - - Q'\ :sub:`0[5:0]; B1[1:0]=pad` - - pad + - Q'\ :sub:`0[19:12]` + - Q'\ :sub:`0[11:4]` + - Q'\ :sub:`0[3:0]; B2[3:0]=pad` - pad * - start + offset + 4: - - Q'\ :sub:`1[13:6]` - - Q'\ :sub:`1[5:0]; B1[1:0]=pad` - - pad + - Q'\ :sub:`1[19:12]` + - Q'\ :sub:`1[11:4]` + - Q'\ :sub:`1[3:0]; B2[3:0]=pad` - pad diff --git a/Documentation/media/uapi/v4l/pixfmt-sdr-cu08.rst b/Documentation/userspace-api/media/v4l/pixfmt-sdr-ru12le.rst similarity index 53% rename from Documentation/media/uapi/v4l/pixfmt-sdr-cu08.rst rename to Documentation/userspace-api/media/v4l/pixfmt-sdr-ru12le.rst index f37df90f5a21..c9cde8d425f7 100644 --- a/Documentation/media/uapi/v4l/pixfmt-sdr-cu08.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-sdr-ru12le.rst @@ -3,35 +3,37 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _v4l2-sdr-fmt-cu8: +.. _V4L2-SDR-FMT-RU12LE: -************************* -V4L2_SDR_FMT_CU8 ('CU08') -************************* +**************************** +V4L2_SDR_FMT_RU12LE ('RU12') +**************************** -Complex unsigned 8-bit IQ sample + +Real unsigned 12-bit little endian sample Description =========== -This format contains sequence of complex number samples. Each complex -number consist two parts, called In-phase and Quadrature (IQ). Both I -and Q are represented as a 8 bit unsigned number. I value comes first -and Q value after that. +This format contains sequence of real number samples. Each sample is +represented as a 12 bit unsigned little endian number. Sample is stored +in 16 bit space with unused high bits padded with 0. **Byte Order.** Each cell is one byte. + + + .. flat-table:: :header-rows: 0 :stub-columns: 0 * - start + 0: - - I'\ :sub:`0` - * - start + 1: - - Q'\ :sub:`0` + - I'\ :sub:`0[7:0]` + - I'\ :sub:`0[11:8]` diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb10-ipu3.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb10-ipu3.rst similarity index 99% rename from Documentation/media/uapi/v4l/pixfmt-srggb10-ipu3.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb10-ipu3.rst index 75279f0fdad8..5afa02a66698 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb10-ipu3.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb10-ipu3.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb14.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb10.rst similarity index 64% rename from Documentation/media/uapi/v4l/pixfmt-srggb14.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb10.rst index 3420d4d1825e..37cc1bb8241f 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb14.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb10.rst @@ -3,46 +3,47 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-SRGGB14: -.. _v4l2-pix-fmt-sbggr14: -.. _v4l2-pix-fmt-sgbrg14: -.. _v4l2-pix-fmt-sgrbg14: - +.. _V4L2-PIX-FMT-SRGGB10: +.. _v4l2-pix-fmt-sbggr10: +.. _v4l2-pix-fmt-sgbrg10: +.. _v4l2-pix-fmt-sgrbg10: *************************************************************************************************************************** -V4L2_PIX_FMT_SRGGB14 ('RG14'), V4L2_PIX_FMT_SGRBG14 ('GR14'), V4L2_PIX_FMT_SGBRG14 ('GB14'), V4L2_PIX_FMT_SBGGR14 ('BG14'), +V4L2_PIX_FMT_SRGGB10 ('RG10'), V4L2_PIX_FMT_SGRBG10 ('BA10'), V4L2_PIX_FMT_SGBRG10 ('GB10'), V4L2_PIX_FMT_SBGGR10 ('BG10'), *************************************************************************************************************************** -14-bit Bayer formats expanded to 16 bits +V4L2_PIX_FMT_SGRBG10 +V4L2_PIX_FMT_SGBRG10 +V4L2_PIX_FMT_SBGGR10 +10-bit Bayer formats expanded to 16 bits Description =========== -These four pixel formats are raw sRGB / Bayer formats with 14 bits per -colour. Each sample is stored in a 16-bit word, with two unused high -bits filled with zeros. Each n-pixel row contains n/2 green samples -and n/2 blue or red samples, with alternating red and blue rows. Bytes -are stored in memory in little endian order. They are conventionally -described as GRGR... BGBG..., RGRG... GBGB..., etc. Below is an -example of a small V4L2_PIX_FMT_SBGGR14 image: +These four pixel formats are raw sRGB / Bayer formats with 10 bits per +sample. Each sample is stored in a 16-bit word, with 6 unused +high bits filled with zeros. Each n-pixel row contains n/2 green samples and +n/2 blue or red samples, with alternating red and blue rows. Bytes are +stored in memory in little endian order. They are conventionally described +as GRGR... BGBG..., RGRG... GBGB..., etc. Below is an example of one of +these formats: **Byte Order.** -Each cell is one byte, the two most significant bits in the high bytes are -zero. +Each cell is one byte, the 6 most significant bits in the high bytes +are 0. + .. flat-table:: :header-rows: 0 :stub-columns: 0 - :widths: 2 1 1 1 1 1 1 1 1 - * - start + 0: - B\ :sub:`00low` diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb10dpcm8.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb10alaw8.rst similarity index 55% rename from Documentation/media/uapi/v4l/pixfmt-srggb10dpcm8.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb10alaw8.rst index cbc9c0a52ab4..f1b8627f0141 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb10dpcm8.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb10alaw8.rst @@ -3,25 +3,22 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-SBGGR10DPCM8: -.. _v4l2-pix-fmt-sgbrg10dpcm8: -.. _v4l2-pix-fmt-sgrbg10dpcm8: -.. _v4l2-pix-fmt-srggb10dpcm8: - +.. _V4L2-PIX-FMT-SBGGR10ALAW8: +.. _v4l2-pix-fmt-sgbrg10alaw8: +.. _v4l2-pix-fmt-sgrbg10alaw8: +.. _v4l2-pix-fmt-srggb10alaw8: *********************************************************************************************************************************************** -V4L2_PIX_FMT_SBGGR10DPCM8 ('bBA8'), V4L2_PIX_FMT_SGBRG10DPCM8 ('bGA8'), V4L2_PIX_FMT_SGRBG10DPCM8 ('BD10'), V4L2_PIX_FMT_SRGGB10DPCM8 ('bRA8'), +V4L2_PIX_FMT_SBGGR10ALAW8 ('aBA8'), V4L2_PIX_FMT_SGBRG10ALAW8 ('aGA8'), V4L2_PIX_FMT_SGRBG10ALAW8 ('agA8'), V4L2_PIX_FMT_SRGGB10ALAW8 ('aRA8'), *********************************************************************************************************************************************** -*man V4L2_PIX_FMT_SBGGR10DPCM8(2)* - -V4L2_PIX_FMT_SGBRG10DPCM8 -V4L2_PIX_FMT_SGRBG10DPCM8 -V4L2_PIX_FMT_SRGGB10DPCM8 +V4L2_PIX_FMT_SGBRG10ALAW8 +V4L2_PIX_FMT_SGRBG10ALAW8 +V4L2_PIX_FMT_SRGGB10ALAW8 10-bit Bayer formats compressed to 8 bits @@ -29,7 +26,6 @@ Description =========== These four pixel formats are raw sRGB / Bayer formats with 10 bits per -colour compressed to 8 bits each, using DPCM compression. DPCM, -differential pulse-code modulation, is lossy. Each colour component -consumes 8 bits of memory. In other respects this format is similar to -:ref:`V4L2-PIX-FMT-SRGGB10`. +color compressed to 8 bits each, using the A-LAW algorithm. Each color +component consumes 8 bits of memory. In other respects this format is +similar to :ref:`V4L2-PIX-FMT-SRGGB8`. diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb10alaw8.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb10dpcm8.rst similarity index 55% rename from Documentation/media/uapi/v4l/pixfmt-srggb10alaw8.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb10dpcm8.rst index 5bb58764b532..9814c4ffac68 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb10alaw8.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb10dpcm8.rst @@ -3,22 +3,25 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-SBGGR10ALAW8: -.. _v4l2-pix-fmt-sgbrg10alaw8: -.. _v4l2-pix-fmt-sgrbg10alaw8: -.. _v4l2-pix-fmt-srggb10alaw8: +.. _V4L2-PIX-FMT-SBGGR10DPCM8: +.. _v4l2-pix-fmt-sgbrg10dpcm8: +.. _v4l2-pix-fmt-sgrbg10dpcm8: +.. _v4l2-pix-fmt-srggb10dpcm8: + *********************************************************************************************************************************************** -V4L2_PIX_FMT_SBGGR10ALAW8 ('aBA8'), V4L2_PIX_FMT_SGBRG10ALAW8 ('aGA8'), V4L2_PIX_FMT_SGRBG10ALAW8 ('agA8'), V4L2_PIX_FMT_SRGGB10ALAW8 ('aRA8'), +V4L2_PIX_FMT_SBGGR10DPCM8 ('bBA8'), V4L2_PIX_FMT_SGBRG10DPCM8 ('bGA8'), V4L2_PIX_FMT_SGRBG10DPCM8 ('BD10'), V4L2_PIX_FMT_SRGGB10DPCM8 ('bRA8'), *********************************************************************************************************************************************** -V4L2_PIX_FMT_SGBRG10ALAW8 -V4L2_PIX_FMT_SGRBG10ALAW8 -V4L2_PIX_FMT_SRGGB10ALAW8 +*man V4L2_PIX_FMT_SBGGR10DPCM8(2)* + +V4L2_PIX_FMT_SGBRG10DPCM8 +V4L2_PIX_FMT_SGRBG10DPCM8 +V4L2_PIX_FMT_SRGGB10DPCM8 10-bit Bayer formats compressed to 8 bits @@ -26,6 +29,7 @@ Description =========== These four pixel formats are raw sRGB / Bayer formats with 10 bits per -color compressed to 8 bits each, using the A-LAW algorithm. Each color -component consumes 8 bits of memory. In other respects this format is -similar to :ref:`V4L2-PIX-FMT-SRGGB8`. +colour compressed to 8 bits each, using DPCM compression. DPCM, +differential pulse-code modulation, is lossy. Each colour component +consumes 8 bits of memory. In other respects this format is similar to +:ref:`V4L2-PIX-FMT-SRGGB10`. diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb10p.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb10p.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-srggb10p.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb10p.rst index fd32660a3766..76a4d278e640 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb10p.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb10p.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb12.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb12.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-srggb12.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb12.rst index 6fb6a937e6ad..98ae80b968ae 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb12.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb12.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb12p.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb12p.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-srggb12p.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb12p.rst index 045540bc0d86..7309dd7fa60f 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb12p.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb12p.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb10.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb14.rst similarity index 64% rename from Documentation/media/uapi/v4l/pixfmt-srggb10.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb14.rst index cab7fbb1f2fe..a4c7a392fe7f 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb10.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb14.rst @@ -3,47 +3,46 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-SRGGB10: -.. _v4l2-pix-fmt-sbggr10: -.. _v4l2-pix-fmt-sgbrg10: -.. _v4l2-pix-fmt-sgrbg10: +.. _V4L2-PIX-FMT-SRGGB14: +.. _v4l2-pix-fmt-sbggr14: +.. _v4l2-pix-fmt-sgbrg14: +.. _v4l2-pix-fmt-sgrbg14: + *************************************************************************************************************************** -V4L2_PIX_FMT_SRGGB10 ('RG10'), V4L2_PIX_FMT_SGRBG10 ('BA10'), V4L2_PIX_FMT_SGBRG10 ('GB10'), V4L2_PIX_FMT_SBGGR10 ('BG10'), +V4L2_PIX_FMT_SRGGB14 ('RG14'), V4L2_PIX_FMT_SGRBG14 ('GR14'), V4L2_PIX_FMT_SGBRG14 ('GB14'), V4L2_PIX_FMT_SBGGR14 ('BG14'), *************************************************************************************************************************** -V4L2_PIX_FMT_SGRBG10 -V4L2_PIX_FMT_SGBRG10 -V4L2_PIX_FMT_SBGGR10 -10-bit Bayer formats expanded to 16 bits +14-bit Bayer formats expanded to 16 bits Description =========== -These four pixel formats are raw sRGB / Bayer formats with 10 bits per -sample. Each sample is stored in a 16-bit word, with 6 unused -high bits filled with zeros. Each n-pixel row contains n/2 green samples and -n/2 blue or red samples, with alternating red and blue rows. Bytes are -stored in memory in little endian order. They are conventionally described -as GRGR... BGBG..., RGRG... GBGB..., etc. Below is an example of one of -these formats: +These four pixel formats are raw sRGB / Bayer formats with 14 bits per +colour. Each sample is stored in a 16-bit word, with two unused high +bits filled with zeros. Each n-pixel row contains n/2 green samples +and n/2 blue or red samples, with alternating red and blue rows. Bytes +are stored in memory in little endian order. They are conventionally +described as GRGR... BGBG..., RGRG... GBGB..., etc. Below is an +example of a small V4L2_PIX_FMT_SBGGR14 image: **Byte Order.** -Each cell is one byte, the 6 most significant bits in the high bytes -are 0. - +Each cell is one byte, the two most significant bits in the high bytes are +zero. .. flat-table:: :header-rows: 0 :stub-columns: 0 + :widths: 2 1 1 1 1 1 1 1 1 + * - start + 0: - B\ :sub:`00low` diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb14p.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb14p.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-srggb14p.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb14p.rst index 051ae3d05bc3..ec1239ada316 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb14p.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb14p.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb16.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb16.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-srggb16.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb16.rst index 36527c49eaf7..885f0d1f331d 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb16.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb16.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-srggb8.rst b/Documentation/userspace-api/media/v4l/pixfmt-srggb8.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-srggb8.rst rename to Documentation/userspace-api/media/v4l/pixfmt-srggb8.rst index f5233c1e2314..c275e6ef09f9 100644 --- a/Documentation/media/uapi/v4l/pixfmt-srggb8.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-srggb8.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-tch-td08.rst b/Documentation/userspace-api/media/v4l/pixfmt-tch-td08.rst similarity index 96% rename from Documentation/media/uapi/v4l/pixfmt-tch-td08.rst rename to Documentation/userspace-api/media/v4l/pixfmt-tch-td08.rst index b7d3d6ccebc5..165c9be2bfc5 100644 --- a/Documentation/media/uapi/v4l/pixfmt-tch-td08.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-tch-td08.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-tch-td16.rst b/Documentation/userspace-api/media/v4l/pixfmt-tch-td16.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-tch-td16.rst rename to Documentation/userspace-api/media/v4l/pixfmt-tch-td16.rst index 6f1be873bec1..6dca01182175 100644 --- a/Documentation/media/uapi/v4l/pixfmt-tch-td16.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-tch-td16.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-tch-tu08.rst b/Documentation/userspace-api/media/v4l/pixfmt-tch-tu08.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-tch-tu08.rst rename to Documentation/userspace-api/media/v4l/pixfmt-tch-tu08.rst index 2d447475aaa7..f1380b72977f 100644 --- a/Documentation/media/uapi/v4l/pixfmt-tch-tu08.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-tch-tu08.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-tch-tu16.rst b/Documentation/userspace-api/media/v4l/pixfmt-tch-tu16.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-tch-tu16.rst rename to Documentation/userspace-api/media/v4l/pixfmt-tch-tu16.rst index cb3da6687a58..2b9e1b15abcf 100644 --- a/Documentation/media/uapi/v4l/pixfmt-tch-tu16.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-tch-tu16.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-uv8.rst b/Documentation/userspace-api/media/v4l/pixfmt-uv8.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-uv8.rst rename to Documentation/userspace-api/media/v4l/pixfmt-uv8.rst index 6008c898305d..a36c1a4d64a4 100644 --- a/Documentation/media/uapi/v4l/pixfmt-uv8.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-uv8.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-y41p.rst b/Documentation/userspace-api/media/v4l/pixfmt-uyvy.rst similarity index 57% rename from Documentation/media/uapi/v4l/pixfmt-y41p.rst rename to Documentation/userspace-api/media/v4l/pixfmt-uyvy.rst index 829c68afd8d7..776cb37f76f1 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y41p.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-uyvy.rst @@ -3,40 +3,33 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-Y41P: +.. _V4L2-PIX-FMT-UYVY: ************************** -V4L2_PIX_FMT_Y41P ('Y41P') +V4L2_PIX_FMT_UYVY ('UYVY') ************************** -Format with ¼ horizontal chroma resolution, also known as YUV 4:1:1 +Variation of ``V4L2_PIX_FMT_YUYV`` with different order of samples in +memory Description =========== -In this format each 12 bytes is eight pixels. In the twelve bytes are -two CbCr pairs and eight Y's. The first CbCr pair goes with the first -four Y's, and the second CbCr pair goes with the other four Y's. The Cb -and Cr components have one fourth the horizontal resolution of the Y -component. - -Do not confuse this format with -:ref:`V4L2_PIX_FMT_YUV411P `. Y41P is derived -from "YUV 4:1:1 *packed*", while YUV411P stands for "YUV 4:1:1 -*planar*". +In this format each four bytes is two pixels. Each four bytes is two +Y's, a Cb and a Cr. Each Y goes to one of the pixels, and the Cb and Cr +belong to both pixels. As you can see, the Cr and Cb components have +half the horizontal resolution of the Y component. **Byte Order.** Each cell is one byte. - - .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -50,11 +43,7 @@ Each cell is one byte. - Y'\ :sub:`02` - Cr\ :sub:`01` - Y'\ :sub:`03` - - Y'\ :sub:`04` - - Y'\ :sub:`05` - - Y'\ :sub:`06` - - Y'\ :sub:`07` - * - start + 12: + * - start + 8: - Cb\ :sub:`10` - Y'\ :sub:`10` - Cr\ :sub:`10` @@ -63,11 +52,7 @@ Each cell is one byte. - Y'\ :sub:`12` - Cr\ :sub:`11` - Y'\ :sub:`13` - - Y'\ :sub:`14` - - Y'\ :sub:`15` - - Y'\ :sub:`16` - - Y'\ :sub:`17` - * - start + 24: + * - start + 16: - Cb\ :sub:`20` - Y'\ :sub:`20` - Cr\ :sub:`20` @@ -76,11 +61,7 @@ Each cell is one byte. - Y'\ :sub:`22` - Cr\ :sub:`21` - Y'\ :sub:`23` - - Y'\ :sub:`24` - - Y'\ :sub:`25` - - Y'\ :sub:`26` - - Y'\ :sub:`27` - * - start + 36: + * - start + 24: - Cb\ :sub:`30` - Y'\ :sub:`30` - Cr\ :sub:`30` @@ -89,70 +70,48 @@ Each cell is one byte. - Y'\ :sub:`32` - Cr\ :sub:`31` - Y'\ :sub:`33` - - Y'\ :sub:`34` - - Y'\ :sub:`35` - - Y'\ :sub:`36` - - Y'\ :sub:`37` **Color Sample Location:** + + .. flat-table:: :header-rows: 0 :stub-columns: 0 * - - 0 - - 1 - + - 1 - 2 - - 3 - - 4 - - 5 - - - 6 - - 7 + - 3 * - 0 - - Y - Y - C - Y - Y - - Y - - Y - C - Y - - Y * - 1 - - Y - Y - C - Y - Y - - Y - - Y - C - Y - - Y * - 2 - - Y - Y - C - Y - Y - - Y - - Y - C - Y - - Y * - 3 - - Y - Y - C - Y - Y - - Y - - Y - C - Y - - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst b/Documentation/userspace-api/media/v4l/pixfmt-v4l2-mplane.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst rename to Documentation/userspace-api/media/v4l/pixfmt-v4l2-mplane.rst index 054275c0dfc1..444b4082684c 100644 --- a/Documentation/media/uapi/v4l/pixfmt-v4l2-mplane.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-v4l2-mplane.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-v4l2.rst b/Documentation/userspace-api/media/v4l/pixfmt-v4l2.rst similarity index 99% rename from Documentation/media/uapi/v4l/pixfmt-v4l2.rst rename to Documentation/userspace-api/media/v4l/pixfmt-v4l2.rst index a993b861bf75..759420a872d6 100644 --- a/Documentation/media/uapi/v4l/pixfmt-v4l2.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-v4l2.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-uyvy.rst b/Documentation/userspace-api/media/v4l/pixfmt-vyuy.rst similarity index 79% rename from Documentation/media/uapi/v4l/pixfmt-uyvy.rst rename to Documentation/userspace-api/media/v4l/pixfmt-vyuy.rst index 72da2639d37e..6cd574e78e4c 100644 --- a/Documentation/media/uapi/v4l/pixfmt-uyvy.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-vyuy.rst @@ -3,14 +3,14 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-UYVY: +.. _V4L2-PIX-FMT-VYUY: ************************** -V4L2_PIX_FMT_UYVY ('UYVY') +V4L2_PIX_FMT_VYUY ('VYUY') ************************** @@ -35,47 +35,45 @@ Each cell is one byte. :stub-columns: 0 * - start + 0: - - Cb\ :sub:`00` - - Y'\ :sub:`00` - Cr\ :sub:`00` + - Y'\ :sub:`00` + - Cb\ :sub:`00` - Y'\ :sub:`01` - - Cb\ :sub:`01` - - Y'\ :sub:`02` - Cr\ :sub:`01` + - Y'\ :sub:`02` + - Cb\ :sub:`01` - Y'\ :sub:`03` * - start + 8: - - Cb\ :sub:`10` - - Y'\ :sub:`10` - Cr\ :sub:`10` + - Y'\ :sub:`10` + - Cb\ :sub:`10` - Y'\ :sub:`11` - - Cb\ :sub:`11` - - Y'\ :sub:`12` - Cr\ :sub:`11` + - Y'\ :sub:`12` + - Cb\ :sub:`11` - Y'\ :sub:`13` * - start + 16: - - Cb\ :sub:`20` - - Y'\ :sub:`20` - Cr\ :sub:`20` + - Y'\ :sub:`20` + - Cb\ :sub:`20` - Y'\ :sub:`21` - - Cb\ :sub:`21` - - Y'\ :sub:`22` - Cr\ :sub:`21` + - Y'\ :sub:`22` + - Cb\ :sub:`21` - Y'\ :sub:`23` * - start + 24: - - Cb\ :sub:`30` - - Y'\ :sub:`30` - Cr\ :sub:`30` + - Y'\ :sub:`30` + - Cb\ :sub:`30` - Y'\ :sub:`31` - - Cb\ :sub:`31` - - Y'\ :sub:`32` - Cr\ :sub:`31` + - Y'\ :sub:`32` + - Cb\ :sub:`31` - Y'\ :sub:`33` **Color Sample Location:** - - .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -84,8 +82,8 @@ Each cell is one byte. - 0 - - 1 - - 2 - + - 2 - 3 * - 0 - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-y10.rst b/Documentation/userspace-api/media/v4l/pixfmt-y10.rst similarity index 96% rename from Documentation/media/uapi/v4l/pixfmt-y10.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y10.rst index 63277686764a..dfb352ae6784 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y10.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y10.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-y10b.rst b/Documentation/userspace-api/media/v4l/pixfmt-y10b.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-y10b.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y10b.rst index 49c4dd432413..b5d89d6d5c52 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y10b.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y10b.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-y10p.rst b/Documentation/userspace-api/media/v4l/pixfmt-y10p.rst similarity index 96% rename from Documentation/media/uapi/v4l/pixfmt-y10p.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y10p.rst index 39cd789dcb59..ffb6e1631b78 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y10p.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y10p.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-y16-be.rst b/Documentation/userspace-api/media/v4l/pixfmt-y12.rst similarity index 53% rename from Documentation/media/uapi/v4l/pixfmt-y16-be.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y12.rst index 1e72bfe2d557..4226c49232de 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y16-be.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y12.rst @@ -3,15 +3,15 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-Y16-BE: +.. _V4L2-PIX-FMT-Y12: -**************************************** -V4L2_PIX_FMT_Y16_BE ('Y16 ' | (1 << 31)) -**************************************** +************************* +V4L2_PIX_FMT_Y12 ('Y12 ') +************************* Grey-scale image @@ -20,13 +20,9 @@ Grey-scale image Description =========== -This is a grey-scale image with a depth of 16 bits per pixel. The most -significant byte is stored at lower memory addresses (big-endian). - -.. note:: - - The actual sampling precision may be lower than 16 bits, for - example 10 bits per pixel with values in range 0 to 1023. +This is a grey-scale image with a depth of 12 bits per pixel. Pixels are +stored in 16-bit words with unused high bits padded with 0. The least +significant byte is stored at lower memory addresses (little-endian). **Byte Order.** Each cell is one byte. @@ -39,38 +35,38 @@ Each cell is one byte. :stub-columns: 0 * - start + 0: - - Y'\ :sub:`00high` - Y'\ :sub:`00low` - - Y'\ :sub:`01high` + - Y'\ :sub:`00high` - Y'\ :sub:`01low` - - Y'\ :sub:`02high` + - Y'\ :sub:`01high` - Y'\ :sub:`02low` - - Y'\ :sub:`03high` + - Y'\ :sub:`02high` - Y'\ :sub:`03low` + - Y'\ :sub:`03high` * - start + 8: - - Y'\ :sub:`10high` - Y'\ :sub:`10low` - - Y'\ :sub:`11high` + - Y'\ :sub:`10high` - Y'\ :sub:`11low` - - Y'\ :sub:`12high` + - Y'\ :sub:`11high` - Y'\ :sub:`12low` - - Y'\ :sub:`13high` + - Y'\ :sub:`12high` - Y'\ :sub:`13low` + - Y'\ :sub:`13high` * - start + 16: - - Y'\ :sub:`20high` - Y'\ :sub:`20low` - - Y'\ :sub:`21high` + - Y'\ :sub:`20high` - Y'\ :sub:`21low` - - Y'\ :sub:`22high` + - Y'\ :sub:`21high` - Y'\ :sub:`22low` - - Y'\ :sub:`23high` + - Y'\ :sub:`22high` - Y'\ :sub:`23low` + - Y'\ :sub:`23high` * - start + 24: - - Y'\ :sub:`30high` - Y'\ :sub:`30low` - - Y'\ :sub:`31high` + - Y'\ :sub:`30high` - Y'\ :sub:`31low` - - Y'\ :sub:`32high` + - Y'\ :sub:`31high` - Y'\ :sub:`32low` - - Y'\ :sub:`33high` + - Y'\ :sub:`32high` - Y'\ :sub:`33low` + - Y'\ :sub:`33high` diff --git a/Documentation/media/uapi/v4l/pixfmt-y12i.rst b/Documentation/userspace-api/media/v4l/pixfmt-y12i.rst similarity index 95% rename from Documentation/media/uapi/v4l/pixfmt-y12i.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y12i.rst index 1d4a14e1ec6e..b4752754337b 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y12i.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y12i.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-y14.rst b/Documentation/userspace-api/media/v4l/pixfmt-y14.rst similarity index 96% rename from Documentation/media/uapi/v4l/pixfmt-y14.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y14.rst index 5c260f8da088..d702b6549160 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y14.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y14.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-y16.rst b/Documentation/userspace-api/media/v4l/pixfmt-y16-be.rst similarity index 61% rename from Documentation/media/uapi/v4l/pixfmt-y16.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y16-be.rst index f77d900db131..f4eda7b95b51 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y16.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y16-be.rst @@ -3,15 +3,15 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-Y16: +.. _V4L2-PIX-FMT-Y16-BE: -************************* -V4L2_PIX_FMT_Y16 ('Y16 ') -************************* +**************************************** +V4L2_PIX_FMT_Y16_BE ('Y16 ' | (1 << 31)) +**************************************** Grey-scale image @@ -20,8 +20,8 @@ Grey-scale image Description =========== -This is a grey-scale image with a depth of 16 bits per pixel. The least -significant byte is stored at lower memory addresses (little-endian). +This is a grey-scale image with a depth of 16 bits per pixel. The most +significant byte is stored at lower memory addresses (big-endian). .. note:: @@ -39,38 +39,38 @@ Each cell is one byte. :stub-columns: 0 * - start + 0: - - Y'\ :sub:`00low` - Y'\ :sub:`00high` - - Y'\ :sub:`01low` + - Y'\ :sub:`00low` - Y'\ :sub:`01high` - - Y'\ :sub:`02low` + - Y'\ :sub:`01low` - Y'\ :sub:`02high` - - Y'\ :sub:`03low` + - Y'\ :sub:`02low` - Y'\ :sub:`03high` + - Y'\ :sub:`03low` * - start + 8: - - Y'\ :sub:`10low` - Y'\ :sub:`10high` - - Y'\ :sub:`11low` + - Y'\ :sub:`10low` - Y'\ :sub:`11high` - - Y'\ :sub:`12low` + - Y'\ :sub:`11low` - Y'\ :sub:`12high` - - Y'\ :sub:`13low` + - Y'\ :sub:`12low` - Y'\ :sub:`13high` + - Y'\ :sub:`13low` * - start + 16: - - Y'\ :sub:`20low` - Y'\ :sub:`20high` - - Y'\ :sub:`21low` + - Y'\ :sub:`20low` - Y'\ :sub:`21high` - - Y'\ :sub:`22low` + - Y'\ :sub:`21low` - Y'\ :sub:`22high` - - Y'\ :sub:`23low` + - Y'\ :sub:`22low` - Y'\ :sub:`23high` + - Y'\ :sub:`23low` * - start + 24: - - Y'\ :sub:`30low` - Y'\ :sub:`30high` - - Y'\ :sub:`31low` + - Y'\ :sub:`30low` - Y'\ :sub:`31high` - - Y'\ :sub:`32low` + - Y'\ :sub:`31low` - Y'\ :sub:`32high` - - Y'\ :sub:`33low` + - Y'\ :sub:`32low` - Y'\ :sub:`33high` + - Y'\ :sub:`33low` diff --git a/Documentation/media/uapi/v4l/pixfmt-y12.rst b/Documentation/userspace-api/media/v4l/pixfmt-y16.rst similarity index 83% rename from Documentation/media/uapi/v4l/pixfmt-y12.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y16.rst index 33a943b4996a..a092b0a5ff12 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y12.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y16.rst @@ -3,14 +3,14 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-Y12: +.. _V4L2-PIX-FMT-Y16: ************************* -V4L2_PIX_FMT_Y12 ('Y12 ') +V4L2_PIX_FMT_Y16 ('Y16 ') ************************* @@ -20,10 +20,14 @@ Grey-scale image Description =========== -This is a grey-scale image with a depth of 12 bits per pixel. Pixels are -stored in 16-bit words with unused high bits padded with 0. The least +This is a grey-scale image with a depth of 16 bits per pixel. The least significant byte is stored at lower memory addresses (little-endian). +.. note:: + + The actual sampling precision may be lower than 16 bits, for + example 10 bits per pixel with values in range 0 to 1023. + **Byte Order.** Each cell is one byte. diff --git a/Documentation/media/uapi/v4l/pixfmt-yvyu.rst b/Documentation/userspace-api/media/v4l/pixfmt-y41p.rst similarity index 51% rename from Documentation/media/uapi/v4l/pixfmt-yvyu.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y41p.rst index 656a830fed02..211afd7593cc 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yvyu.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y41p.rst @@ -3,73 +3,96 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-YVYU: +.. _V4L2-PIX-FMT-Y41P: ************************** -V4L2_PIX_FMT_YVYU ('YVYU') +V4L2_PIX_FMT_Y41P ('Y41P') ************************** -Variation of ``V4L2_PIX_FMT_YUYV`` with different order of samples in -memory +Format with ¼ horizontal chroma resolution, also known as YUV 4:1:1 Description =========== -In this format each four bytes is two pixels. Each four bytes is two -Y's, a Cb and a Cr. Each Y goes to one of the pixels, and the Cb and Cr -belong to both pixels. As you can see, the Cr and Cb components have -half the horizontal resolution of the Y component. +In this format each 12 bytes is eight pixels. In the twelve bytes are +two CbCr pairs and eight Y's. The first CbCr pair goes with the first +four Y's, and the second CbCr pair goes with the other four Y's. The Cb +and Cr components have one fourth the horizontal resolution of the Y +component. + +Do not confuse this format with +:ref:`V4L2_PIX_FMT_YUV411P `. Y41P is derived +from "YUV 4:1:1 *packed*", while YUV411P stands for "YUV 4:1:1 +*planar*". **Byte Order.** Each cell is one byte. + + .. flat-table:: :header-rows: 0 :stub-columns: 0 * - start + 0: + - Cb\ :sub:`00` - Y'\ :sub:`00` - Cr\ :sub:`00` - Y'\ :sub:`01` - - Cb\ :sub:`00` + - Cb\ :sub:`01` - Y'\ :sub:`02` - Cr\ :sub:`01` - Y'\ :sub:`03` - - Cb\ :sub:`01` - * - start + 8: + - Y'\ :sub:`04` + - Y'\ :sub:`05` + - Y'\ :sub:`06` + - Y'\ :sub:`07` + * - start + 12: + - Cb\ :sub:`10` - Y'\ :sub:`10` - Cr\ :sub:`10` - Y'\ :sub:`11` - - Cb\ :sub:`10` + - Cb\ :sub:`11` - Y'\ :sub:`12` - Cr\ :sub:`11` - Y'\ :sub:`13` - - Cb\ :sub:`11` - * - start + 16: + - Y'\ :sub:`14` + - Y'\ :sub:`15` + - Y'\ :sub:`16` + - Y'\ :sub:`17` + * - start + 24: + - Cb\ :sub:`20` - Y'\ :sub:`20` - Cr\ :sub:`20` - Y'\ :sub:`21` - - Cb\ :sub:`20` + - Cb\ :sub:`21` - Y'\ :sub:`22` - Cr\ :sub:`21` - Y'\ :sub:`23` - - Cb\ :sub:`21` - * - start + 24: + - Y'\ :sub:`24` + - Y'\ :sub:`25` + - Y'\ :sub:`26` + - Y'\ :sub:`27` + * - start + 36: + - Cb\ :sub:`30` - Y'\ :sub:`30` - Cr\ :sub:`30` - Y'\ :sub:`31` - - Cb\ :sub:`30` + - Cb\ :sub:`31` - Y'\ :sub:`32` - Cr\ :sub:`31` - Y'\ :sub:`33` - - Cb\ :sub:`31` + - Y'\ :sub:`34` + - Y'\ :sub:`35` + - Y'\ :sub:`36` + - Y'\ :sub:`37` **Color Sample Location:** @@ -80,36 +103,56 @@ Each cell is one byte. * - - 0 - - - 1 - - 2 - + - 2 - 3 + - 4 + - 5 + - + - 6 + - 7 * - 0 + - Y - Y - C - Y - Y + - Y + - Y - C - Y + - Y * - 1 + - Y - Y - C - Y - Y + - Y + - Y - C - Y + - Y * - 2 + - Y - Y - C - Y - Y + - Y + - Y - C - Y + - Y * - 3 + - Y - Y - C - Y - Y + - Y + - Y - C - Y + - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-y8i.rst b/Documentation/userspace-api/media/v4l/pixfmt-y8i.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-y8i.rst rename to Documentation/userspace-api/media/v4l/pixfmt-y8i.rst index 2c88ed90522d..4248c6f735b7 100644 --- a/Documentation/media/uapi/v4l/pixfmt-y8i.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-y8i.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-yuv411p.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuv410.rst similarity index 53% rename from Documentation/media/uapi/v4l/pixfmt-yuv411p.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuv410.rst index 83ddaa3f8dfb..1d20115f2b1d 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yuv411p.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuv410.rst @@ -3,43 +3,47 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-YUV411P: +.. _V4L2-PIX-FMT-YVU410: +.. _v4l2-pix-fmt-yuv410: -***************************** -V4L2_PIX_FMT_YUV411P ('411P') -***************************** +********************************************************** +V4L2_PIX_FMT_YVU410 ('YVU9'), V4L2_PIX_FMT_YUV410 ('YUV9') +********************************************************** -Format with ¼ horizontal chroma resolution, also known as YUV 4:1:1. -Planar layout as opposed to ``V4L2_PIX_FMT_Y41P`` +V4L2_PIX_FMT_YUV410 +Planar formats with ¼ horizontal and vertical chroma resolution, also +known as YUV 4:1:0 Description =========== -This format is not commonly used. This is a planar format similar to the -4:2:2 planar format except with half as many chroma. The three +These are planar formats, as opposed to a packed format. The three components are separated into three sub-images or planes. The Y plane is -first. The Y plane has one byte per pixel. The Cb plane immediately -follows the Y plane in memory. The Cb plane is ¼ the width of the Y -plane (and of the image). Each Cb belongs to 4 pixels all on the same -row. For example, Cb\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`, -Y'\ :sub:`02` and Y'\ :sub:`03`. Following the Cb plane is the Cr plane, -just like the Cb plane. +first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_YVU410``, +the Cr plane immediately follows the Y plane in memory. The Cr plane is +¼ the width and ¼ the height of the Y plane (and of the image). Each Cr +belongs to 16 pixels, a four-by-four square of the image. Following the +Cr plane is the Cb plane, just like the Cr plane. +``V4L2_PIX_FMT_YUV410`` is the same, except the Cb plane comes first, +then the Cr plane. If the Y plane has pad bytes after each row, then the Cr and Cb planes -have ¼ as many pad bytes after their rows. In other words, four C x rows -(including padding) is exactly as long as one Y row (including padding). +have ¼ as many pad bytes after their rows. In other words, four Cx rows +(including padding) are exactly as long as one Y row (including +padding). **Byte Order.** Each cell is one byte. + .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -65,21 +69,9 @@ Each cell is one byte. - Y'\ :sub:`32` - Y'\ :sub:`33` * - start + 16: - - Cb\ :sub:`00` - * - start + 17: - - Cb\ :sub:`10` - * - start + 18: - - Cb\ :sub:`20` - * - start + 19: - - Cb\ :sub:`30` - * - start + 20: - Cr\ :sub:`00` - * - start + 21: - - Cr\ :sub:`10` - * - start + 22: - - Cr\ :sub:`20` - * - start + 23: - - Cr\ :sub:`30` + * - start + 17: + - Cb\ :sub:`00` **Color Sample Location:** @@ -92,31 +84,51 @@ Each cell is one byte. * - - 0 + - - 1 - - 2 + - - 3 * - 0 - Y + - - Y - - C + - - Y + - - Y + * - * - 1 - Y + - - Y - - C + - - Y + - - Y + * - + - + - + - + - C + - + - + - * - 2 - Y + - - Y - - C + - - Y + - - Y + * - * - 3 - Y + - - Y - - C + - - Y + - - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-yuv410.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuv411p.rst similarity index 53% rename from Documentation/media/uapi/v4l/pixfmt-yuv410.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuv411p.rst index ebb72a5c7ceb..967ba7ce41a2 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yuv410.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuv411p.rst @@ -3,47 +3,43 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-YVU410: -.. _v4l2-pix-fmt-yuv410: +.. _V4L2-PIX-FMT-YUV411P: -********************************************************** -V4L2_PIX_FMT_YVU410 ('YVU9'), V4L2_PIX_FMT_YUV410 ('YUV9') -********************************************************** +***************************** +V4L2_PIX_FMT_YUV411P ('411P') +***************************** -V4L2_PIX_FMT_YUV410 -Planar formats with ¼ horizontal and vertical chroma resolution, also -known as YUV 4:1:0 +Format with ¼ horizontal chroma resolution, also known as YUV 4:1:1. +Planar layout as opposed to ``V4L2_PIX_FMT_Y41P`` Description =========== -These are planar formats, as opposed to a packed format. The three +This format is not commonly used. This is a planar format similar to the +4:2:2 planar format except with half as many chroma. The three components are separated into three sub-images or planes. The Y plane is -first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_YVU410``, -the Cr plane immediately follows the Y plane in memory. The Cr plane is -¼ the width and ¼ the height of the Y plane (and of the image). Each Cr -belongs to 16 pixels, a four-by-four square of the image. Following the -Cr plane is the Cb plane, just like the Cr plane. -``V4L2_PIX_FMT_YUV410`` is the same, except the Cb plane comes first, -then the Cr plane. +first. The Y plane has one byte per pixel. The Cb plane immediately +follows the Y plane in memory. The Cb plane is ¼ the width of the Y +plane (and of the image). Each Cb belongs to 4 pixels all on the same +row. For example, Cb\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`, +Y'\ :sub:`02` and Y'\ :sub:`03`. Following the Cb plane is the Cr plane, +just like the Cb plane. If the Y plane has pad bytes after each row, then the Cr and Cb planes -have ¼ as many pad bytes after their rows. In other words, four Cx rows -(including padding) are exactly as long as one Y row (including -padding). +have ¼ as many pad bytes after their rows. In other words, four C x rows +(including padding) is exactly as long as one Y row (including padding). **Byte Order.** Each cell is one byte. - .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -69,9 +65,21 @@ Each cell is one byte. - Y'\ :sub:`32` - Y'\ :sub:`33` * - start + 16: - - Cr\ :sub:`00` - * - start + 17: - Cb\ :sub:`00` + * - start + 17: + - Cb\ :sub:`10` + * - start + 18: + - Cb\ :sub:`20` + * - start + 19: + - Cb\ :sub:`30` + * - start + 20: + - Cr\ :sub:`00` + * - start + 21: + - Cr\ :sub:`10` + * - start + 22: + - Cr\ :sub:`20` + * - start + 23: + - Cr\ :sub:`30` **Color Sample Location:** @@ -84,51 +92,31 @@ Each cell is one byte. * - - 0 - - - 1 - - 2 - - - 3 * - 0 - Y - - - Y - - + - C - Y - - - Y - * - * - 1 - Y - - - Y - - + - C - Y - - - Y - * - - - - - - - - - C - - - - - - * - 2 - Y - - - Y - - + - C - Y - - - Y - * - * - 3 - Y - - - Y - - + - C - Y - - - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-nv12.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuv420.rst similarity index 52% rename from Documentation/media/uapi/v4l/pixfmt-nv12.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuv420.rst index b8c021b07fd2..7cb685cc8289 100644 --- a/Documentation/media/uapi/v4l/pixfmt-nv12.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuv420.rst @@ -3,45 +3,48 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-NV12: -.. _V4L2-PIX-FMT-NV21: +.. _V4L2-PIX-FMT-YVU420: +.. _V4L2-PIX-FMT-YUV420: -****************************************************** -V4L2_PIX_FMT_NV12 ('NV12'), V4L2_PIX_FMT_NV21 ('NV21') -****************************************************** +********************************************************** +V4L2_PIX_FMT_YVU420 ('YV12'), V4L2_PIX_FMT_YUV420 ('YU12') +********************************************************** -V4L2_PIX_FMT_NV21 -Formats with ½ horizontal and vertical chroma resolution, also known as -YUV 4:2:0. One luminance and one chrominance plane with alternating -chroma samples as opposed to ``V4L2_PIX_FMT_YVU420`` +V4L2_PIX_FMT_YUV420 +Planar formats with ½ horizontal and vertical chroma resolution, also +known as YUV 4:2:0 Description =========== -These are two-plane versions of the YUV 4:2:0 format. The three -components are separated into two sub-images or planes. The Y plane is -first. The Y plane has one byte per pixel. For ``V4L2_PIX_FMT_NV12``, a -combined CbCr plane immediately follows the Y plane in memory. The CbCr -plane is the same width, in bytes, as the Y plane (and of the image), -but is half as tall in pixels. Each CbCr pair belongs to four pixels. -For example, Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, -Y'\ :sub:`01`, Y'\ :sub:`10`, Y'\ :sub:`11`. ``V4L2_PIX_FMT_NV21`` is -the same except the Cb and Cr bytes are swapped, the CrCb plane starts -with a Cr byte. - -If the Y plane has pad bytes after each row, then the CbCr plane has as -many pad bytes after its rows. +These are planar formats, as opposed to a packed format. The three +components are separated into three sub- images or planes. The Y plane +is first. The Y plane has one byte per pixel. For +``V4L2_PIX_FMT_YVU420``, the Cr plane immediately follows the Y plane in +memory. The Cr plane is half the width and half the height of the Y +plane (and of the image). Each Cr belongs to four pixels, a two-by-two +square of the image. For example, Cr\ :sub:`0` belongs to Y'\ :sub:`00`, +Y'\ :sub:`01`, Y'\ :sub:`10`, and Y'\ :sub:`11`. Following the Cr plane +is the Cb plane, just like the Cr plane. ``V4L2_PIX_FMT_YUV420`` is the +same except the Cb plane comes first, then the Cr plane. + +If the Y plane has pad bytes after each row, then the Cr and Cb planes +have half as many pad bytes after their rows. In other words, two Cx +rows (including padding) is exactly as long as one Y row (including +padding). **Byte Order.** Each cell is one byte. + + .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -67,19 +70,23 @@ Each cell is one byte. - Y'\ :sub:`32` - Y'\ :sub:`33` * - start + 16: - - Cb\ :sub:`00` - Cr\ :sub:`00` - - Cb\ :sub:`01` - Cr\ :sub:`01` + * - start + 18: + - Cr\ :sub:`10` + - Cr\ :sub:`11` * - start + 20: + - Cb\ :sub:`00` + - Cb\ :sub:`01` + * - start + 22: - Cb\ :sub:`10` - - Cr\ :sub:`10` - Cb\ :sub:`11` - - Cr\ :sub:`11` **Color Sample Location:** + + .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -88,6 +95,7 @@ Each cell is one byte. - 0 - - 1 + - - 2 - - 3 @@ -95,6 +103,7 @@ Each cell is one byte. - Y - - Y + - - Y - - Y @@ -103,12 +112,14 @@ Each cell is one byte. - C - - + - - C - * - 1 - Y - - Y + - - Y - - Y @@ -117,6 +128,7 @@ Each cell is one byte. - Y - - Y + - - Y - - Y @@ -125,12 +137,14 @@ Each cell is one byte. - C - - + - - C - * - 3 - Y - - Y + - - Y - - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-yuv420m.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuv420m.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-yuv420m.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuv420m.rst index c29b30c6445a..80c14d4f5acb 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yuv420m.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuv420m.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-yuv422m.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuv422m.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-yuv422m.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuv422m.rst index 737fd94a9ae9..29b78480ccad 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yuv422m.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuv422m.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-yuv422p.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuv422p.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-yuv422p.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuv422p.rst index 7cebb6ebb621..73fde222d820 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yuv422p.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuv422p.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-yuv444m.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuv444m.rst similarity index 98% rename from Documentation/media/uapi/v4l/pixfmt-yuv444m.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuv444m.rst index 8f14ca378816..7073ac7f842d 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yuv444m.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuv444m.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-yuyv.rst b/Documentation/userspace-api/media/v4l/pixfmt-yuyv.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-yuyv.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yuyv.rst index d86d7f086c41..fe70e007787d 100644 --- a/Documentation/media/uapi/v4l/pixfmt-yuyv.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yuyv.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt-m420.rst b/Documentation/userspace-api/media/v4l/pixfmt-yvyu.rst similarity index 51% rename from Documentation/media/uapi/v4l/pixfmt-m420.rst rename to Documentation/userspace-api/media/v4l/pixfmt-yvyu.rst index c2bae959bf51..96c1b537d5a0 100644 --- a/Documentation/media/uapi/v4l/pixfmt-m420.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-yvyu.rst @@ -3,35 +3,28 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _V4L2-PIX-FMT-M420: +.. _V4L2-PIX-FMT-YVYU: ************************** -V4L2_PIX_FMT_M420 ('M420') +V4L2_PIX_FMT_YVYU ('YVYU') ************************** -Format with ½ horizontal and vertical chroma resolution, also known as -YUV 4:2:0. Hybrid plane line-interleaved layout. + +Variation of ``V4L2_PIX_FMT_YUYV`` with different order of samples in +memory Description =========== -M420 is a YUV format with ½ horizontal and vertical chroma subsampling -(YUV 4:2:0). Pixels are organized as interleaved luma and chroma planes. -Two lines of luma data are followed by one line of chroma data. - -The luma plane has one byte per pixel. The chroma plane contains -interleaved CbCr pixels subsampled by ½ in the horizontal and vertical -directions. Each CbCr pair belongs to four pixels. For example, -Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`, -Y'\ :sub:`10`, Y'\ :sub:`11`. - -All line lengths are identical: if the Y lines include pad bytes so do -the CbCr lines. +In this format each four bytes is two pixels. Each four bytes is two +Y's, a Cb and a Cr. Each Y goes to one of the pixels, and the Cb and Cr +belong to both pixels. As you can see, the Cr and Cb components have +half the horizontal resolution of the Y component. **Byte Order.** Each cell is one byte. @@ -43,40 +36,44 @@ Each cell is one byte. * - start + 0: - Y'\ :sub:`00` + - Cr\ :sub:`00` - Y'\ :sub:`01` + - Cb\ :sub:`00` - Y'\ :sub:`02` + - Cr\ :sub:`01` - Y'\ :sub:`03` - * - start + 4: + - Cb\ :sub:`01` + * - start + 8: - Y'\ :sub:`10` + - Cr\ :sub:`10` - Y'\ :sub:`11` + - Cb\ :sub:`10` - Y'\ :sub:`12` + - Cr\ :sub:`11` - Y'\ :sub:`13` - * - start + 8: - - Cb\ :sub:`00` - - Cr\ :sub:`00` - - Cb\ :sub:`01` - - Cr\ :sub:`01` + - Cb\ :sub:`11` * - start + 16: - Y'\ :sub:`20` + - Cr\ :sub:`20` - Y'\ :sub:`21` + - Cb\ :sub:`20` - Y'\ :sub:`22` + - Cr\ :sub:`21` - Y'\ :sub:`23` - * - start + 20: + - Cb\ :sub:`21` + * - start + 24: - Y'\ :sub:`30` + - Cr\ :sub:`30` - Y'\ :sub:`31` + - Cb\ :sub:`30` - Y'\ :sub:`32` + - Cr\ :sub:`31` - Y'\ :sub:`33` - * - start + 24: - - Cb\ :sub:`10` - - Cr\ :sub:`10` - - Cb\ :sub:`11` - - Cr\ :sub:`11` + - Cb\ :sub:`31` **Color Sample Location:** - - .. flat-table:: :header-rows: 0 :stub-columns: 0 @@ -90,44 +87,29 @@ Each cell is one byte. - 3 * - 0 - Y - - - - Y + - C - Y - - - Y - * - - - - C - - - - - - C - - + - Y * - 1 - Y - - + - C - Y - Y - - + - C - Y - * - * - 2 - Y - - - - Y + - C - Y - - - Y - * - - - - - C - - - - - C - - + - Y * - 3 - Y - - + - C - Y - Y - - + - C - Y diff --git a/Documentation/media/uapi/v4l/pixfmt-z16.rst b/Documentation/userspace-api/media/v4l/pixfmt-z16.rst similarity index 97% rename from Documentation/media/uapi/v4l/pixfmt-z16.rst rename to Documentation/userspace-api/media/v4l/pixfmt-z16.rst index eccf235bf02d..fe2fb21edeea 100644 --- a/Documentation/media/uapi/v4l/pixfmt-z16.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt-z16.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/pixfmt.rst b/Documentation/userspace-api/media/v4l/pixfmt.rst similarity index 96% rename from Documentation/media/uapi/v4l/pixfmt.rst rename to Documentation/userspace-api/media/v4l/pixfmt.rst index a7d4cd43a298..70ca3a5c2cf1 100644 --- a/Documentation/media/uapi/v4l/pixfmt.rst +++ b/Documentation/userspace-api/media/v4l/pixfmt.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/planar-apis.rst b/Documentation/userspace-api/media/v4l/planar-apis.rst similarity index 98% rename from Documentation/media/uapi/v4l/planar-apis.rst rename to Documentation/userspace-api/media/v4l/planar-apis.rst index a422dc9d592c..6247b0c4ab4d 100644 --- a/Documentation/media/uapi/v4l/planar-apis.rst +++ b/Documentation/userspace-api/media/v4l/planar-apis.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/querycap.rst b/Documentation/userspace-api/media/v4l/querycap.rst similarity index 96% rename from Documentation/media/uapi/v4l/querycap.rst rename to Documentation/userspace-api/media/v4l/querycap.rst index 8d01ef52f780..35fba2a9e09b 100644 --- a/Documentation/media/uapi/v4l/querycap.rst +++ b/Documentation/userspace-api/media/v4l/querycap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/rw.rst b/Documentation/userspace-api/media/v4l/rw.rst similarity index 97% rename from Documentation/media/uapi/v4l/rw.rst rename to Documentation/userspace-api/media/v4l/rw.rst index 6e498fcf32c4..ce2768c994d0 100644 --- a/Documentation/media/uapi/v4l/rw.rst +++ b/Documentation/userspace-api/media/v4l/rw.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/dvb/dmx_types.rst b/Documentation/userspace-api/media/v4l/sdr-formats.rst similarity index 51% rename from Documentation/media/uapi/dvb/dmx_types.rst rename to Documentation/userspace-api/media/v4l/sdr-formats.rst index b5cf704199e5..b7a1be75251f 100644 --- a/Documentation/media/uapi/dvb/dmx_types.rst +++ b/Documentation/userspace-api/media/v4l/sdr-formats.rst @@ -3,14 +3,27 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _dmx_types: +.. _sdr-formats: -**************** -Demux Data Types -**************** +*********** +SDR Formats +*********** -.. kernel-doc:: include/uapi/linux/dvb/dmx.h +These formats are used for :ref:`SDR ` interface only. + + +.. toctree:: + :maxdepth: 1 + + pixfmt-sdr-cu08 + pixfmt-sdr-cu16le + pixfmt-sdr-cs08 + pixfmt-sdr-cs14le + pixfmt-sdr-ru12le + pixfmt-sdr-pcu16be + pixfmt-sdr-pcu18be + pixfmt-sdr-pcu20be diff --git a/Documentation/media/uapi/v4l/selection-api-configuration.rst b/Documentation/userspace-api/media/v4l/selection-api-configuration.rst similarity index 99% rename from Documentation/media/uapi/v4l/selection-api-configuration.rst rename to Documentation/userspace-api/media/v4l/selection-api-configuration.rst index 6e0c98c37067..67ff67fd734e 100644 --- a/Documentation/media/uapi/v4l/selection-api-configuration.rst +++ b/Documentation/userspace-api/media/v4l/selection-api-configuration.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/selection-api-examples.rst b/Documentation/userspace-api/media/v4l/selection-api-examples.rst similarity index 97% rename from Documentation/media/uapi/v4l/selection-api-examples.rst rename to Documentation/userspace-api/media/v4l/selection-api-examples.rst index bb288b06cc17..2f4027211129 100644 --- a/Documentation/media/uapi/v4l/selection-api-examples.rst +++ b/Documentation/userspace-api/media/v4l/selection-api-examples.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/selection-api-intro.rst b/Documentation/userspace-api/media/v4l/selection-api-intro.rst similarity index 96% rename from Documentation/media/uapi/v4l/selection-api-intro.rst rename to Documentation/userspace-api/media/v4l/selection-api-intro.rst index 0faed02d0226..0994ca25be5e 100644 --- a/Documentation/media/uapi/v4l/selection-api-intro.rst +++ b/Documentation/userspace-api/media/v4l/selection-api-intro.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/common-defs.rst b/Documentation/userspace-api/media/v4l/selection-api-targets.rst similarity index 52% rename from Documentation/media/uapi/v4l/common-defs.rst rename to Documentation/userspace-api/media/v4l/selection-api-targets.rst index 504c6c93c9b0..56eab969c9d8 100644 --- a/Documentation/media/uapi/v4l/common-defs.rst +++ b/Documentation/userspace-api/media/v4l/selection-api-targets.rst @@ -3,18 +3,25 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _common-defs: +***************** +Selection targets +***************** -****************************************************** -Common definitions for V4L2 and V4L2 subdev interfaces -****************************************************** +.. _sel-targets-capture: -.. toctree:: - :maxdepth: 1 +.. kernel-figure:: selection.svg + :alt: selection.svg + :align: center - selections-common + Cropping and composing targets + + Targets used by a cropping, composing and scaling process + + + +See :ref:`v4l2-selection-targets` for more information. diff --git a/Documentation/media/uapi/v4l/selection-api-vs-crop-api.rst b/Documentation/userspace-api/media/v4l/selection-api-vs-crop-api.rst similarity index 97% rename from Documentation/media/uapi/v4l/selection-api-vs-crop-api.rst rename to Documentation/userspace-api/media/v4l/selection-api-vs-crop-api.rst index 79b3abca341a..a9360a000022 100644 --- a/Documentation/media/uapi/v4l/selection-api-vs-crop-api.rst +++ b/Documentation/userspace-api/media/v4l/selection-api-vs-crop-api.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/async.rst b/Documentation/userspace-api/media/v4l/selection-api.rst similarity index 51% rename from Documentation/media/uapi/v4l/async.rst rename to Documentation/userspace-api/media/v4l/selection-api.rst index be9539313f60..b86e387721df 100644 --- a/Documentation/media/uapi/v4l/async.rst +++ b/Documentation/userspace-api/media/v4l/selection-api.rst @@ -3,14 +3,21 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _async: +.. _selection-api: -**************** -Asynchronous I/O -**************** +Cropping, composing and scaling -- the SELECTION API +==================================================== -This method is not defined yet. + +.. toctree:: + :maxdepth: 1 + + selection-api-intro.rst + selection-api-targets.rst + selection-api-configuration.rst + selection-api-vs-crop-api.rst + selection-api-examples.rst diff --git a/Documentation/media/uapi/v4l/selection.svg b/Documentation/userspace-api/media/v4l/selection.svg similarity index 99% rename from Documentation/media/uapi/v4l/selection.svg rename to Documentation/userspace-api/media/v4l/selection.svg index 59d2bec9b278..c0e00ab2ae6b 100644 --- a/Documentation/media/uapi/v4l/selection.svg +++ b/Documentation/userspace-api/media/v4l/selection.svg @@ -22,7 +22,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GPL-2.0 OR GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/selections-common.rst b/Documentation/userspace-api/media/v4l/selections-common.rst similarity index 94% rename from Documentation/media/uapi/v4l/selections-common.rst rename to Documentation/userspace-api/media/v4l/selections-common.rst index 28b32db280f2..d5ea05869a61 100644 --- a/Documentation/media/uapi/v4l/selections-common.rst +++ b/Documentation/userspace-api/media/v4l/selections-common.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/standard.rst b/Documentation/userspace-api/media/v4l/standard.rst similarity index 99% rename from Documentation/media/uapi/v4l/standard.rst rename to Documentation/userspace-api/media/v4l/standard.rst index bf8959b72988..61c341508eb3 100644 --- a/Documentation/media/uapi/v4l/standard.rst +++ b/Documentation/userspace-api/media/v4l/standard.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/streaming-par.rst b/Documentation/userspace-api/media/v4l/streaming-par.rst similarity index 96% rename from Documentation/media/uapi/v4l/streaming-par.rst rename to Documentation/userspace-api/media/v4l/streaming-par.rst index 425bd0ff1477..6d1a1b93ac8b 100644 --- a/Documentation/media/uapi/v4l/streaming-par.rst +++ b/Documentation/userspace-api/media/v4l/streaming-par.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/subdev-formats.rst b/Documentation/userspace-api/media/v4l/subdev-formats.rst similarity index 99% rename from Documentation/media/uapi/v4l/subdev-formats.rst rename to Documentation/userspace-api/media/v4l/subdev-formats.rst index 17bfb2beaa6a..9a4d61b0d76f 100644 --- a/Documentation/media/uapi/v4l/subdev-formats.rst +++ b/Documentation/userspace-api/media/v4l/subdev-formats.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/subdev-image-processing-crop.svg b/Documentation/userspace-api/media/v4l/subdev-image-processing-crop.svg similarity index 99% rename from Documentation/media/uapi/v4l/subdev-image-processing-crop.svg rename to Documentation/userspace-api/media/v4l/subdev-image-processing-crop.svg index 59321e09929d..109bbcebd3b4 100644 --- a/Documentation/media/uapi/v4l/subdev-image-processing-crop.svg +++ b/Documentation/userspace-api/media/v4l/subdev-image-processing-crop.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/subdev-image-processing-full.svg b/Documentation/userspace-api/media/v4l/subdev-image-processing-full.svg similarity index 99% rename from Documentation/media/uapi/v4l/subdev-image-processing-full.svg rename to Documentation/userspace-api/media/v4l/subdev-image-processing-full.svg index e739c54fbbfb..cfdb7532d5b6 100644 --- a/Documentation/media/uapi/v4l/subdev-image-processing-full.svg +++ b/Documentation/userspace-api/media/v4l/subdev-image-processing-full.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/subdev-image-processing-scaling-multi-source.svg b/Documentation/userspace-api/media/v4l/subdev-image-processing-scaling-multi-source.svg similarity index 99% rename from Documentation/media/uapi/v4l/subdev-image-processing-scaling-multi-source.svg rename to Documentation/userspace-api/media/v4l/subdev-image-processing-scaling-multi-source.svg index 401d1456958c..f7f1379d30a6 100644 --- a/Documentation/media/uapi/v4l/subdev-image-processing-scaling-multi-source.svg +++ b/Documentation/userspace-api/media/v4l/subdev-image-processing-scaling-multi-source.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/videodev.rst b/Documentation/userspace-api/media/v4l/tch-formats.rst similarity index 58% rename from Documentation/media/uapi/v4l/videodev.rst rename to Documentation/userspace-api/media/v4l/tch-formats.rst index fa3d3398930a..f83aec85fd76 100644 --- a/Documentation/media/uapi/v4l/videodev.rst +++ b/Documentation/userspace-api/media/v4l/tch-formats.rst @@ -3,14 +3,23 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _videodev: +.. _tch-formats: -******************************* -Video For Linux Two Header File -******************************* +************* +Touch Formats +************* -.. kernel-include:: $BUILDDIR/videodev2.h.rst +These formats are used for :ref:`touch` interface only. + + +.. toctree:: + :maxdepth: 1 + + pixfmt-tch-td16 + pixfmt-tch-td08 + pixfmt-tch-tu16 + pixfmt-tch-tu08 diff --git a/Documentation/media/uapi/v4l/tuner.rst b/Documentation/userspace-api/media/v4l/tuner.rst similarity index 98% rename from Documentation/media/uapi/v4l/tuner.rst rename to Documentation/userspace-api/media/v4l/tuner.rst index 601dc535199c..02a396eb6613 100644 --- a/Documentation/media/uapi/v4l/tuner.rst +++ b/Documentation/userspace-api/media/v4l/tuner.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/user-func.rst b/Documentation/userspace-api/media/v4l/user-func.rst similarity index 97% rename from Documentation/media/uapi/v4l/user-func.rst rename to Documentation/userspace-api/media/v4l/user-func.rst index ca0ef21d77fe..f235f88efe89 100644 --- a/Documentation/media/uapi/v4l/user-func.rst +++ b/Documentation/userspace-api/media/v4l/user-func.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/userp.rst b/Documentation/userspace-api/media/v4l/userp.rst similarity index 99% rename from Documentation/media/uapi/v4l/userp.rst rename to Documentation/userspace-api/media/v4l/userp.rst index b19da8655452..2d0fa7353066 100644 --- a/Documentation/media/uapi/v4l/userp.rst +++ b/Documentation/userspace-api/media/v4l/userp.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/v4l2-selection-flags.rst b/Documentation/userspace-api/media/v4l/v4l2-selection-flags.rst similarity index 96% rename from Documentation/media/uapi/v4l/v4l2-selection-flags.rst rename to Documentation/userspace-api/media/v4l/v4l2-selection-flags.rst index cc8f2a2b7cba..5c6f351b2443 100644 --- a/Documentation/media/uapi/v4l/v4l2-selection-flags.rst +++ b/Documentation/userspace-api/media/v4l/v4l2-selection-flags.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/v4l2-selection-targets.rst b/Documentation/userspace-api/media/v4l/v4l2-selection-targets.rst similarity index 97% rename from Documentation/media/uapi/v4l/v4l2-selection-targets.rst rename to Documentation/userspace-api/media/v4l/v4l2-selection-targets.rst index aae0c0013eb1..69f500093aa2 100644 --- a/Documentation/media/uapi/v4l/v4l2-selection-targets.rst +++ b/Documentation/userspace-api/media/v4l/v4l2-selection-targets.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/v4l2.rst b/Documentation/userspace-api/media/v4l/v4l2.rst similarity index 99% rename from Documentation/media/uapi/v4l/v4l2.rst rename to Documentation/userspace-api/media/v4l/v4l2.rst index 97015b9b40b8..ab7c97c39b97 100644 --- a/Documentation/media/uapi/v4l/v4l2.rst +++ b/Documentation/userspace-api/media/v4l/v4l2.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/mediactl/media-header.rst b/Documentation/userspace-api/media/v4l/v4l2grab-example.rst similarity index 50% rename from Documentation/media/uapi/mediactl/media-header.rst rename to Documentation/userspace-api/media/v4l/v4l2grab-example.rst index 1cb7c88aeff0..270738876f72 100644 --- a/Documentation/media/uapi/mediactl/media-header.rst +++ b/Documentation/userspace-api/media/v4l/v4l2grab-example.rst @@ -3,15 +3,22 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _media_header: +.. _v4l2grab-example: -**************************** -Media Controller Header File -**************************** +********************************** +Video Grabber example using libv4l +********************************** -.. kernel-include:: $BUILDDIR/media.h.rst +This program demonstrates how to grab V4L2 images in ppm format by using +libv4l handlers. The advantage is that this grabber can potentially work +with any V4L2 driver. + +.. toctree:: + :maxdepth: 1 + + v4l2grab.c diff --git a/Documentation/media/uapi/v4l/v4l2grab.c.rst b/Documentation/userspace-api/media/v4l/v4l2grab.c.rst similarity index 98% rename from Documentation/media/uapi/v4l/v4l2grab.c.rst rename to Documentation/userspace-api/media/v4l/v4l2grab.c.rst index e76c5fb7bd19..a21ff357a830 100644 --- a/Documentation/media/uapi/v4l/v4l2grab.c.rst +++ b/Documentation/userspace-api/media/v4l/v4l2grab.c.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vbi_525.svg b/Documentation/userspace-api/media/v4l/vbi_525.svg similarity index 99% rename from Documentation/media/uapi/v4l/vbi_525.svg rename to Documentation/userspace-api/media/v4l/vbi_525.svg index 6cd5def22b1f..b7d09057617e 100644 --- a/Documentation/media/uapi/v4l/vbi_525.svg +++ b/Documentation/userspace-api/media/v4l/vbi_525.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/vbi_625.svg b/Documentation/userspace-api/media/v4l/vbi_625.svg similarity index 99% rename from Documentation/media/uapi/v4l/vbi_625.svg rename to Documentation/userspace-api/media/v4l/vbi_625.svg index 7aaae5ec4878..e1f5e8552c37 100644 --- a/Documentation/media/uapi/v4l/vbi_625.svg +++ b/Documentation/userspace-api/media/v4l/vbi_625.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/vbi_hsync.svg b/Documentation/userspace-api/media/v4l/vbi_hsync.svg similarity index 99% rename from Documentation/media/uapi/v4l/vbi_hsync.svg rename to Documentation/userspace-api/media/v4l/vbi_hsync.svg index f8e979ada7e3..77606a7b00a4 100644 --- a/Documentation/media/uapi/v4l/vbi_hsync.svg +++ b/Documentation/userspace-api/media/v4l/vbi_hsync.svg @@ -5,7 +5,7 @@ Version 1.1 or any later version published by the Free Software Foundation, with no Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A copy of the license is included at - Documentation/media/uapi/fdl-appendix.rst. + Documentation/userspace-api/media/fdl-appendix.rst. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections --> diff --git a/Documentation/media/uapi/v4l/video.rst b/Documentation/userspace-api/media/v4l/video.rst similarity index 97% rename from Documentation/media/uapi/v4l/video.rst rename to Documentation/userspace-api/media/v4l/video.rst index 69603b5efbb5..9b73dba0eb8d 100644 --- a/Documentation/media/uapi/v4l/video.rst +++ b/Documentation/userspace-api/media/v4l/video.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/compat.rst b/Documentation/userspace-api/media/v4l/videodev.rst similarity index 55% rename from Documentation/media/uapi/v4l/compat.rst rename to Documentation/userspace-api/media/v4l/videodev.rst index f35575a300b4..c8244b895802 100644 --- a/Documentation/media/uapi/v4l/compat.rst +++ b/Documentation/userspace-api/media/v4l/videodev.rst @@ -3,23 +3,14 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections -.. _compat: +.. _videodev: -******* -Changes -******* +******************************* +Video For Linux Two Header File +******************************* -The following chapters document the evolution of the V4L2 API, errata or -extensions. They are also intended to help application and driver -writers to port or update their code. - - -.. toctree:: - :maxdepth: 1 - - diff-v4l - hist-v4l2 +.. kernel-include:: $BUILDDIR/videodev2.h.rst diff --git a/Documentation/media/uapi/v4l/vidioc-create-bufs.rst b/Documentation/userspace-api/media/v4l/vidioc-create-bufs.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-create-bufs.rst rename to Documentation/userspace-api/media/v4l/vidioc-create-bufs.rst index bd08e4f77ae4..bd580232be10 100644 --- a/Documentation/media/uapi/v4l/vidioc-create-bufs.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-create-bufs.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-cropcap.rst b/Documentation/userspace-api/media/v4l/vidioc-cropcap.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-cropcap.rst rename to Documentation/userspace-api/media/v4l/vidioc-cropcap.rst index 019d3d3a0e0d..035ed9d577ae 100644 --- a/Documentation/media/uapi/v4l/vidioc-cropcap.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-cropcap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst b/Documentation/userspace-api/media/v4l/vidioc-dbg-g-chip-info.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst rename to Documentation/userspace-api/media/v4l/vidioc-dbg-g-chip-info.rst index d38031dbe4e4..16078a2d3e3d 100644 --- a/Documentation/media/uapi/v4l/vidioc-dbg-g-chip-info.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-dbg-g-chip-info.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst b/Documentation/userspace-api/media/v4l/vidioc-dbg-g-register.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst rename to Documentation/userspace-api/media/v4l/vidioc-dbg-g-register.rst index 112597c6cad2..6311a63278a5 100644 --- a/Documentation/media/uapi/v4l/vidioc-dbg-g-register.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-dbg-g-register.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst b/Documentation/userspace-api/media/v4l/vidioc-decoder-cmd.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst rename to Documentation/userspace-api/media/v4l/vidioc-decoder-cmd.rst index 784c5980da8d..7986a248bff9 100644 --- a/Documentation/media/uapi/v4l/vidioc-decoder-cmd.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-decoder-cmd.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-dqevent.rst b/Documentation/userspace-api/media/v4l/vidioc-dqevent.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-dqevent.rst rename to Documentation/userspace-api/media/v4l/vidioc-dqevent.rst index 2f37d255352a..a9a176d5256d 100644 --- a/Documentation/media/uapi/v4l/vidioc-dqevent.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-dqevent.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst b/Documentation/userspace-api/media/v4l/vidioc-dv-timings-cap.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst rename to Documentation/userspace-api/media/v4l/vidioc-dv-timings-cap.rst index 1d0acbf14c4f..60730c32bfe4 100644 --- a/Documentation/media/uapi/v4l/vidioc-dv-timings-cap.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-dv-timings-cap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst b/Documentation/userspace-api/media/v4l/vidioc-encoder-cmd.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst rename to Documentation/userspace-api/media/v4l/vidioc-encoder-cmd.rst index c313ca8b8cb5..16269b3b1715 100644 --- a/Documentation/media/uapi/v4l/vidioc-encoder-cmd.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-encoder-cmd.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst b/Documentation/userspace-api/media/v4l/vidioc-enum-dv-timings.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst rename to Documentation/userspace-api/media/v4l/vidioc-enum-dv-timings.rst index 0b286e19b46b..89d6b860193a 100644 --- a/Documentation/media/uapi/v4l/vidioc-enum-dv-timings.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enum-dv-timings.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enum-fmt.rst b/Documentation/userspace-api/media/v4l/vidioc-enum-fmt.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-enum-fmt.rst rename to Documentation/userspace-api/media/v4l/vidioc-enum-fmt.rst index 8ca6ab701e4a..7e3142e11d77 100644 --- a/Documentation/media/uapi/v4l/vidioc-enum-fmt.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enum-fmt.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst b/Documentation/userspace-api/media/v4l/vidioc-enum-frameintervals.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst rename to Documentation/userspace-api/media/v4l/vidioc-enum-frameintervals.rst index 563a67cddeca..0e3db737371f 100644 --- a/Documentation/media/uapi/v4l/vidioc-enum-frameintervals.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enum-frameintervals.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst b/Documentation/userspace-api/media/v4l/vidioc-enum-framesizes.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst rename to Documentation/userspace-api/media/v4l/vidioc-enum-framesizes.rst index cd97546a7122..1934d7da9743 100644 --- a/Documentation/media/uapi/v4l/vidioc-enum-framesizes.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enum-framesizes.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst b/Documentation/userspace-api/media/v4l/vidioc-enum-freq-bands.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst rename to Documentation/userspace-api/media/v4l/vidioc-enum-freq-bands.rst index 0e97c09afe0e..ee3ba67601fa 100644 --- a/Documentation/media/uapi/v4l/vidioc-enum-freq-bands.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enum-freq-bands.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enumaudio.rst b/Documentation/userspace-api/media/v4l/vidioc-enumaudio.rst similarity index 96% rename from Documentation/media/uapi/v4l/vidioc-enumaudio.rst rename to Documentation/userspace-api/media/v4l/vidioc-enumaudio.rst index ee0c336c8721..afe4821e5863 100644 --- a/Documentation/media/uapi/v4l/vidioc-enumaudio.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enumaudio.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enumaudioout.rst b/Documentation/userspace-api/media/v4l/vidioc-enumaudioout.rst similarity index 97% rename from Documentation/media/uapi/v4l/vidioc-enumaudioout.rst rename to Documentation/userspace-api/media/v4l/vidioc-enumaudioout.rst index 3a8882214d62..31c2ae460e2d 100644 --- a/Documentation/media/uapi/v4l/vidioc-enumaudioout.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enumaudioout.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enuminput.rst b/Documentation/userspace-api/media/v4l/vidioc-enuminput.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-enuminput.rst rename to Documentation/userspace-api/media/v4l/vidioc-enuminput.rst index a0e4c4413121..510670bff3de 100644 --- a/Documentation/media/uapi/v4l/vidioc-enuminput.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enuminput.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enumoutput.rst b/Documentation/userspace-api/media/v4l/vidioc-enumoutput.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-enumoutput.rst rename to Documentation/userspace-api/media/v4l/vidioc-enumoutput.rst index 0fea81f60541..591a99cf8000 100644 --- a/Documentation/media/uapi/v4l/vidioc-enumoutput.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enumoutput.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-enumstd.rst b/Documentation/userspace-api/media/v4l/vidioc-enumstd.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-enumstd.rst rename to Documentation/userspace-api/media/v4l/vidioc-enumstd.rst index 1603b1b3b6e8..8a0508536c13 100644 --- a/Documentation/media/uapi/v4l/vidioc-enumstd.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-enumstd.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-expbuf.rst b/Documentation/userspace-api/media/v4l/vidioc-expbuf.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-expbuf.rst rename to Documentation/userspace-api/media/v4l/vidioc-expbuf.rst index 4bd8cd79754c..384a9be9eba0 100644 --- a/Documentation/media/uapi/v4l/vidioc-expbuf.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-expbuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-audio.rst b/Documentation/userspace-api/media/v4l/vidioc-g-audio.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-audio.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-audio.rst index 7af4fe478ba4..68531bcb62ab 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-audio.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-audio.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-audioout.rst b/Documentation/userspace-api/media/v4l/vidioc-g-audioout.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-audioout.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-audioout.rst index c6ea0396a96a..e13b74bf5ce3 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-audioout.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-audioout.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-crop.rst b/Documentation/userspace-api/media/v4l/vidioc-g-crop.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-crop.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-crop.rst index 1eff59dc5f35..10e086be55d5 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-crop.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-crop.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-ctrl.rst b/Documentation/userspace-api/media/v4l/vidioc-g-ctrl.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-ctrl.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-ctrl.rst index 8493b52adbb2..9831b7514028 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-ctrl.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-ctrl.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst b/Documentation/userspace-api/media/v4l/vidioc-g-dv-timings.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-dv-timings.rst index e36dd2622857..84806a893cb7 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-dv-timings.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-dv-timings.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-edid.rst b/Documentation/userspace-api/media/v4l/vidioc-g-edid.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-edid.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-edid.rst index e55b349a0c7e..0620f4cbbcbd 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-edid.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-edid.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-enc-index.rst b/Documentation/userspace-api/media/v4l/vidioc-g-enc-index.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-enc-index.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-enc-index.rst index e285a1f14cdf..8aad30a7c6c3 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-enc-index.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-enc-index.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst index cdb2a2a512d6..add17c9204cb 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-ext-ctrls.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-ext-ctrls.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst b/Documentation/userspace-api/media/v4l/vidioc-g-fbuf.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-fbuf.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-fbuf.rst index 2d197e6bba8f..0124444419ae 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-fbuf.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-fbuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-fmt.rst b/Documentation/userspace-api/media/v4l/vidioc-g-fmt.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-fmt.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-fmt.rst index 1e69bfc46e8d..88bb69ec07e2 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-fmt.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-fmt.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-frequency.rst b/Documentation/userspace-api/media/v4l/vidioc-g-frequency.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-frequency.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-frequency.rst index cc30bae3dd6e..26300e0258a3 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-frequency.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-frequency.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-input.rst b/Documentation/userspace-api/media/v4l/vidioc-g-input.rst similarity index 97% rename from Documentation/media/uapi/v4l/vidioc-g-input.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-input.rst index 76b7d487466e..294e346678c1 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-input.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-input.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst b/Documentation/userspace-api/media/v4l/vidioc-g-jpegcomp.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-jpegcomp.rst index 5480277ab327..3b9981dcb8e0 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-jpegcomp.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-jpegcomp.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-modulator.rst b/Documentation/userspace-api/media/v4l/vidioc-g-modulator.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-modulator.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-modulator.rst index 2c33a8bdcc47..c2072f6e8756 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-modulator.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-modulator.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-output.rst b/Documentation/userspace-api/media/v4l/vidioc-g-output.rst similarity index 97% rename from Documentation/media/uapi/v4l/vidioc-g-output.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-output.rst index 69542d78977b..cad477420fd7 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-output.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-output.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-parm.rst b/Documentation/userspace-api/media/v4l/vidioc-g-parm.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-parm.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-parm.rst index 044a459e073f..42e9f6ee7a59 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-parm.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-parm.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-priority.rst b/Documentation/userspace-api/media/v4l/vidioc-g-priority.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-priority.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-priority.rst index 244b4dbe9df3..c8add130c7a4 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-priority.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-priority.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-selection.rst b/Documentation/userspace-api/media/v4l/vidioc-g-selection.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-selection.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-selection.rst index 7d8ef7ac8e27..faab0454b1e4 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-selection.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-selection.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst b/Documentation/userspace-api/media/v4l/vidioc-g-sliced-vbi-cap.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-sliced-vbi-cap.rst index 388b826d44b3..7a62c4f4e37f 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-sliced-vbi-cap.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-sliced-vbi-cap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-std.rst b/Documentation/userspace-api/media/v4l/vidioc-g-std.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-g-std.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-std.rst index e633e42e3910..b0bdb719d405 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-std.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-std.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-g-tuner.rst b/Documentation/userspace-api/media/v4l/vidioc-g-tuner.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-g-tuner.rst rename to Documentation/userspace-api/media/v4l/vidioc-g-tuner.rst index 82d23b8bd195..40bff6f0a88d 100644 --- a/Documentation/media/uapi/v4l/vidioc-g-tuner.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-g-tuner.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-log-status.rst b/Documentation/userspace-api/media/v4l/vidioc-log-status.rst similarity index 96% rename from Documentation/media/uapi/v4l/vidioc-log-status.rst rename to Documentation/userspace-api/media/v4l/vidioc-log-status.rst index 16bb5509ad66..64c06fa72b9c 100644 --- a/Documentation/media/uapi/v4l/vidioc-log-status.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-log-status.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-overlay.rst b/Documentation/userspace-api/media/v4l/vidioc-overlay.rst similarity index 96% rename from Documentation/media/uapi/v4l/vidioc-overlay.rst rename to Documentation/userspace-api/media/v4l/vidioc-overlay.rst index fc5a86e8c1f2..74310ff486ba 100644 --- a/Documentation/media/uapi/v4l/vidioc-overlay.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-overlay.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-prepare-buf.rst b/Documentation/userspace-api/media/v4l/vidioc-prepare-buf.rst similarity index 96% rename from Documentation/media/uapi/v4l/vidioc-prepare-buf.rst rename to Documentation/userspace-api/media/v4l/vidioc-prepare-buf.rst index 7c6b5f4e1011..b6c09d5b128f 100644 --- a/Documentation/media/uapi/v4l/vidioc-prepare-buf.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-prepare-buf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-qbuf.rst b/Documentation/userspace-api/media/v4l/vidioc-qbuf.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-qbuf.rst rename to Documentation/userspace-api/media/v4l/vidioc-qbuf.rst index 407302d80684..ec0a54fbeb43 100644 --- a/Documentation/media/uapi/v4l/vidioc-qbuf.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-qbuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-query-dv-timings.rst b/Documentation/userspace-api/media/v4l/vidioc-query-dv-timings.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-query-dv-timings.rst rename to Documentation/userspace-api/media/v4l/vidioc-query-dv-timings.rst index e9b055395382..ab86408446f3 100644 --- a/Documentation/media/uapi/v4l/vidioc-query-dv-timings.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-query-dv-timings.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-querybuf.rst b/Documentation/userspace-api/media/v4l/vidioc-querybuf.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-querybuf.rst rename to Documentation/userspace-api/media/v4l/vidioc-querybuf.rst index 7da60b24e8b6..646f91140ccf 100644 --- a/Documentation/media/uapi/v4l/vidioc-querybuf.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-querybuf.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-querycap.rst b/Documentation/userspace-api/media/v4l/vidioc-querycap.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-querycap.rst rename to Documentation/userspace-api/media/v4l/vidioc-querycap.rst index 5f9930195d62..4ce8f87bd54a 100644 --- a/Documentation/media/uapi/v4l/vidioc-querycap.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-querycap.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst b/Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-queryctrl.rst rename to Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst index 8971f4cfb16e..fbb0038d86bf 100644 --- a/Documentation/media/uapi/v4l/vidioc-queryctrl.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-queryctrl.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-querystd.rst b/Documentation/userspace-api/media/v4l/vidioc-querystd.rst similarity index 97% rename from Documentation/media/uapi/v4l/vidioc-querystd.rst rename to Documentation/userspace-api/media/v4l/vidioc-querystd.rst index d8cf28274cfc..899f0ef6eefe 100644 --- a/Documentation/media/uapi/v4l/vidioc-querystd.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-querystd.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-reqbufs.rst b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst similarity index 99% rename from Documentation/media/uapi/v4l/vidioc-reqbufs.rst rename to Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst index d0c643db477a..79884bb4893b 100644 --- a/Documentation/media/uapi/v4l/vidioc-reqbufs.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-reqbufs.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst b/Documentation/userspace-api/media/v4l/vidioc-s-hw-freq-seek.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst rename to Documentation/userspace-api/media/v4l/vidioc-s-hw-freq-seek.rst index 4daec97651f2..4c16e7e89cfa 100644 --- a/Documentation/media/uapi/v4l/vidioc-s-hw-freq-seek.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-s-hw-freq-seek.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-streamon.rst b/Documentation/userspace-api/media/v4l/vidioc-streamon.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-streamon.rst rename to Documentation/userspace-api/media/v4l/vidioc-streamon.rst index 2b5528ec9f89..13e0136d5c25 100644 --- a/Documentation/media/uapi/v4l/vidioc-streamon.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-streamon.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-interval.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst rename to Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-interval.rst index 6b4bf9ef5606..3527745935c7 100644 --- a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-interval.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-interval.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-size.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst rename to Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-size.rst index 253b128b194e..eb7401991d02 100644 --- a/Documentation/media/uapi/v4l/vidioc-subdev-enum-frame-size.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-enum-frame-size.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-enum-mbus-code.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst rename to Documentation/userspace-api/media/v4l/vidioc-subdev-enum-mbus-code.rst index fefe4d7349ee..35b8607203a4 100644 --- a/Documentation/media/uapi/v4l/vidioc-subdev-enum-mbus-code.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-enum-mbus-code.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst rename to Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst index 632ee053accc..8d9fc13015a6 100644 --- a/Documentation/media/uapi/v4l/vidioc-subdev-g-crop.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-crop.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-fmt.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst rename to Documentation/userspace-api/media/v4l/vidioc-subdev-g-fmt.rst index 472577bd1745..69d60e18664b 100644 --- a/Documentation/media/uapi/v4l/vidioc-subdev-g-fmt.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-fmt.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-frame-interval.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst rename to Documentation/userspace-api/media/v4l/vidioc-subdev-g-frame-interval.rst index 4b1b4bc78bfe..b61baaf11624 100644 --- a/Documentation/media/uapi/v4l/vidioc-subdev-g-frame-interval.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-frame-interval.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-selection.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst rename to Documentation/userspace-api/media/v4l/vidioc-subdev-g-selection.rst index fc73d27e6d74..981c95df2dec 100644 --- a/Documentation/media/uapi/v4l/vidioc-subdev-g-selection.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subdev-g-selection.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/vidioc-subscribe-event.rst b/Documentation/userspace-api/media/v4l/vidioc-subscribe-event.rst similarity index 98% rename from Documentation/media/uapi/v4l/vidioc-subscribe-event.rst rename to Documentation/userspace-api/media/v4l/vidioc-subscribe-event.rst index a2d3454555ba..ae3ed73c0a9e 100644 --- a/Documentation/media/uapi/v4l/vidioc-subscribe-event.rst +++ b/Documentation/userspace-api/media/v4l/vidioc-subscribe-event.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/uapi/v4l/yuv-formats.rst b/Documentation/userspace-api/media/v4l/yuv-formats.rst similarity index 97% rename from Documentation/media/uapi/v4l/yuv-formats.rst rename to Documentation/userspace-api/media/v4l/yuv-formats.rst index 3b259e31b7a1..8ee92d0cd769 100644 --- a/Documentation/media/uapi/v4l/yuv-formats.rst +++ b/Documentation/userspace-api/media/v4l/yuv-formats.rst @@ -3,7 +3,7 @@ .. Version 1.1 or any later version published by the Free Software .. Foundation, with no Invariant Sections, no Front-Cover Texts .. and no Back-Cover Texts. A copy of the license is included at -.. Documentation/media/uapi/fdl-appendix.rst. +.. Documentation/userspace-api/media/fdl-appendix.rst. .. .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections diff --git a/Documentation/media/video.h.rst.exceptions b/Documentation/userspace-api/media/video.h.rst.exceptions similarity index 100% rename from Documentation/media/video.h.rst.exceptions rename to Documentation/userspace-api/media/video.h.rst.exceptions diff --git a/Documentation/media/videodev2.h.rst.exceptions b/Documentation/userspace-api/media/videodev2.h.rst.exceptions similarity index 100% rename from Documentation/media/videodev2.h.rst.exceptions rename to Documentation/userspace-api/media/videodev2.h.rst.exceptions diff --git a/MAINTAINERS b/MAINTAINERS index e64e5db31497..0779d9a4eccb 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3903,7 +3903,7 @@ T: git git://linuxtv.org/media_tree.git F: Documentation/ABI/testing/debugfs-cec-error-inj F: Documentation/devicetree/bindings/media/cec.txt F: Documentation/media/kapi/cec-core.rst -F: Documentation/media/uapi/cec +F: Documentation/userspace-api/media/cec F: drivers/media/cec/ F: drivers/media/rc/keymaps/rc-cec.c F: include/media/cec-notifier.h @@ -5126,6 +5126,7 @@ X: Documentation/devicetree/ X: Documentation/firmware-guide/acpi/ X: Documentation/i2c/ X: Documentation/media/ +X: Documentation/userspace-api/media/ X: Documentation/power/ X: Documentation/spi/ @@ -8641,14 +8642,14 @@ M: Bingbu Cao R: Tian Shu Qiu L: linux-media@vger.kernel.org S: Maintained -F: Documentation/media/uapi/v4l/pixfmt-srggb10-ipu3.rst +F: Documentation/userspace-api/media/v4l/pixfmt-srggb10-ipu3.rst F: drivers/media/pci/intel/ipu3/ INTEL IPU3 CSI-2 IMGU DRIVER M: Sakari Ailus L: linux-media@vger.kernel.org S: Maintained -F: Documentation/media/uapi/v4l/pixfmt-meta-intel-ipu3.rst +F: Documentation/userspace-api/media/v4l/pixfmt-meta-intel-ipu3.rst F: Documentation/media/v4l-drivers/ipu3.rst F: Documentation/media/v4l-drivers/ipu3_rcb.svg F: drivers/staging/media/ipu3/ @@ -10608,6 +10609,7 @@ Q: http://patchwork.kernel.org/project/linux-media/list/ T: git git://linuxtv.org/media_tree.git F: Documentation/devicetree/bindings/media/ F: Documentation/media/ +F: Documentation/userspace-api/media/ F: drivers/media/ F: drivers/staging/media/ F: include/linux/platform_data/media/ diff --git a/drivers/media/radio/Kconfig b/drivers/media/radio/Kconfig index eb79d99787bd..f4df16df19d9 100644 --- a/drivers/media/radio/Kconfig +++ b/drivers/media/radio/Kconfig @@ -36,7 +36,7 @@ config RADIO_SI476X In order to control your radio card, you will need to use programs that are compatible with the Video For Linux 2 API. Information on this API and pointers to "v4l2" programs may be found at - . + . To compile this driver as a module, choose M here: the module will be called radio-si476x. @@ -76,7 +76,7 @@ config RADIO_MAXIRADIO In order to control your radio card, you will need to use programs that are compatible with the Video For Linux API. Information on this API and pointers to "v4l" programs may be found at - . + . To compile this driver as a module, choose M here: the module will be called radio-maxiradio. @@ -94,7 +94,7 @@ config RADIO_SHARK In order to control your radio card, you will need to use programs that are compatible with the Video For Linux API. Information on this API and pointers to "v4l" programs may be found at - . + . To compile this driver as a module, choose M here: the module will be called radio-shark. @@ -111,7 +111,7 @@ config RADIO_SHARK2 In order to control your radio card, you will need to use programs that are compatible with the Video For Linux API. Information on this API and pointers to "v4l" programs may be found at - . + . To compile this driver as a module, choose M here: the module will be called radio-shark2. @@ -218,7 +218,7 @@ config RADIO_WL1273 In order to control your radio card, you will need to use programs that are compatible with the Video For Linux 2 API. Information on this API and pointers to "v4l2" programs may be found at - . + . To compile this driver as a module, choose M here: the module will be called radio-wl1273. diff --git a/drivers/media/radio/wl128x/Kconfig b/drivers/media/radio/wl128x/Kconfig index 1dee7277004b..7b45222730aa 100644 --- a/drivers/media/radio/wl128x/Kconfig +++ b/drivers/media/radio/wl128x/Kconfig @@ -13,6 +13,6 @@ config RADIO_WL128X In order to control your radio card, you will need to use programs that are compatible with the Video For Linux 2 API. Information on this API and pointers to "v4l2" programs may be found at - . + . endmenu -- knotmirror 0.0.1