summaryrefslogtreecommitdiffstats
path: root/Documentation (follow)
Commit message (Collapse)AuthorAgeFilesLines
* media: gen-errors.rst: document ENXIO error codeMauro Carvalho Chehab2017-09-051-0/+5
| | | | | | | | This error can be produced at least at the DVB subsystem. As it is generic enough, document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: gen-errors.rst: remove row number commentsMauro Carvalho Chehab2017-09-051-33/+11
| | | | | | | Those are introduced by the conversion scripts and don't really help. Get rid of them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uapi docs: better organize header filesMauro Carvalho Chehab2017-09-058-60/+22
| | | | | | | | | | | | Instead of having one chapter per file, place all of them at the same chapter. That better organize the chapters at the uAPI documentation. As a side effect, now all uAPI headers are at the same page, at the html output, with makes easier to use it as a reference index for the spec. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb rst: identify the documentation gap at the APIMauro Carvalho Chehab2017-09-052-0/+10
| | | | | | Now that DVB spec is almost in sync, document what's missing. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb CA docs: place undocumented data together with ioctlsMauro Carvalho Chehab2017-09-053-61/+19
| | | | | | | | | | Right now, the same undocumented structs are on two places: at ca_data_types.rst and together with their ioctls. Move them to just one place and use the standard way to represent them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca-get-descr-info.rst: document this ioctlMauro Carvalho Chehab2017-09-051-25/+4
| | | | | | | Instead of a generic boilerplate, fill it with relevant information about this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca-get-slot-info.rst: document this ioctlMauro Carvalho Chehab2017-09-051-87/+11
| | | | | | | Instead of a generic boilerplate, fill it with relevant information about this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca-get-cap.rst: document this ioctlMauro Carvalho Chehab2017-09-051-31/+5
| | | | | | | Instead of a generic boilerplate, fill it with relevant information about this ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca-reset.rst: add some description to this ioctlMauro Carvalho Chehab2017-09-051-1/+2
| | | | | | | | While we don't have any documentation for it, based on what's there at Kaffeine and VDR, it seems that this command should be issued before start using CA. So, document it as such. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca.h: document most CA data typesMauro Carvalho Chehab2017-09-051-65/+10
| | | | | | | | | | | | For most of the stuff there, documenting is easy, as the header file contains information. Yet, I was unable to document two data structs: ca_msg and ca_descr As those two structs are used by a few drivers, keep them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca.h: get rid of CA_SET_PIDMauro Carvalho Chehab2017-09-055-77/+0
| | | | | | | | | | | | | | This ioctl seems to be some attempt to support a feature at the bt8xx dst_ca driver. Yet, as said there, it "needs more work". Right now, the code there is just a boilerplate. At the end of the day, no driver uses this ioctl, nor it is documented anywhere (except for "needs more work"). So, get rid of it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: net.rst: Fix the level of a section of the net chapterMauro Carvalho Chehab2017-09-051-1/+0
| | | | | | | Due to a mistake, the DVB net chapter was actually broken into two different chapters. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dmx.h: add kernel-doc markups and use it at Documentation/Mauro Carvalho Chehab2017-09-052-172/+6
| | | | | | | | | | | The demux documentation is pretty poor nowadays: most of the structs and enums aren't documented at all. Add proper kernel-doc markups for them and use it. Now, the demux API data structures are fully documented :-) Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dmx.h: get rid of GET_DMX_EVENTMauro Carvalho Chehab2017-09-053-80/+0
| | | | | | | | | | This seems to be a pure fictional API :-) It only exists at the DVB book, with no code implemeting it. So, just get rid of it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dmx.h: get rid of DMX_SET_SOURCEMauro Carvalho Chehab2017-09-054-78/+0
| | | | | | | | No driver uses this ioctl, nor it is documented anywhere. So, get rid of it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dmx.h: get rid of DMX_GET_CAPSMauro Carvalho Chehab2017-09-054-55/+0
| | | | | | | | | There's no driver currently using it; it is also not documented about what it would be supposed to do. So, get rid of it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dmx.h: get rid of unused DMX_KERNEL_CLIENTMauro Carvalho Chehab2017-09-052-2/+0
| | | | | | | There's a flag defined for Digital TV demux that is not used anywhere, called DMX_KERNEL_CLIENT. Get rid of it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: fe_property_parameters.rst: better document bandwidthMauro Carvalho Chehab2017-09-051-15/+23
| | | | | | | Use a table to document the supported bandwidths. That makes it clearer to readers. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: fe_property_parameters.rst: better define properties usageMauro Carvalho Chehab2017-09-051-7/+75
| | | | | | | | Several frontend properties are specific to a subset of the delivery systems. Make it clearer when describing each property. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb frontend docs: use kernel-doc documentationMauro Carvalho Chehab2017-09-0516-1855/+309
| | | | | | | | | | | Now that frontend.h contains most documentation for the frontend, remove the duplicated information from Documentation/ and use the kernel-doc auto-generated one instead. That should simplify maintainership of DVB frontend uAPI, as most of the documentation will stick with the header file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb/intro: adjust the notices about optional hardwareMauro Carvalho Chehab2017-09-051-12/+17
| | | | | | | | | | | | | Both CA and decoders are optional. Also, the presence or absence has nothing to do on being a PCI card or not. Nowadays, most hardware leaves the decoders to either the GPU or to some ISP inside the SoC, instead of implementing it inside the Digital TV part of the device. So, change the wording to reflect the hardware changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb/intro: update the history part of the documentMauro Carvalho Chehab2017-09-051-6/+10
| | | | | | | Convergence doesn't exist anymore. The community itself maintains the spec. Update accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb/intro: update references for TV standardsMauro Carvalho Chehab2017-09-051-3/+6
| | | | | | | The references there are only for DVB. Add missing references for ATSC and ISDB standards. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb/intro: use the term Digital TV to refer to the systemMauro Carvalho Chehab2017-09-051-12/+12
| | | | | | | | | | | On several places at the introduction, a digital TV board and its kernel support is called as DVB. The reason is simple: by the time the document was written, there were no other digital TV standards :-) Modernize the specs by referring to them as Digital TV. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: docs-next: update the fe_status documentation for FE_NONEColin Ian King2017-08-271-6/+14
| | | | | | | | | | Recently added FE_NONE to the enum fe_status, so update the documentation accordingly. [mchehab@s-opensource.com: change description to actually reflect what FE_NONE means: no lock of any kind] Signed-off-by: Colin Ian King <colin.king@canonical.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvbproperty.rst: minor editorial changesMauro Carvalho Chehab2017-08-271-13/+12
| | | | | | | Do some minor editorial changes to make this chapter visually better, and the example a little bit clearer. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvbproperty.rst: improve notes about legacy frontend callsMauro Carvalho Chehab2017-08-271-14/+25
| | | | | | | | | | The description of the DVBv5 API was written a long time ago, where the API was still new, and there were not apps using it. Now that the API is stable and used by new applications, clarify that DVBv3 calls should not be used and why. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: frontend.rst: mention MMT at the documentationMauro Carvalho Chehab2017-08-271-3/+2
| | | | | | | | The ATSC 3.0 uses MPEG Media Transport, with is not currently supported. Yet, we'll need to implement it sooner or later. So, mention about it at the specs. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: frontend.rst: convert SEC note into footnoteMauro Carvalho Chehab2017-08-271-8/+11
| | | | | | | | The description of what SEC means fits well as a footnote. That makes the need of saying that SEC is only for Satellite when it was mentioned, as the footnote already says that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: frontend.rst: fix supported delivery systemsMauro Carvalho Chehab2017-08-271-3/+5
| | | | | | | | | | | | | The introduction for the frontend chapter is not quite correct: - it tells that it supports only three types of delivery systems, in opposite to three *groups*; - It adds ISDB-C to the list of supported systems, but, this is not true. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb/intro.rst: Use verbatim font where neededMauro Carvalho Chehab2017-08-271-2/+2
| | | | | | | | | | | | The device numbering for DVB uses "M" and "N" as vars for the number of the device, but sometimes this is printed using normal font instead of verbatim. While here, remove an extra space after quotation marks. This is a minor cleanup with no changes at the text. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: docs-rst: media: Document broken frame handling in stream stop for CSI-2Sakari Ailus2017-08-271-0/+10
| | | | | | | | | | Some CSI-2 transmitters will finish an ongoing frame whereas others will not. Document that receiver drivers should not assume a particular behaviour but to work in both cases. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Reviewed-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt: bindings: Document DT bindings for Analog devices as3645aSakari Ailus2017-08-271-0/+71
| | | | | | | | | | Document DT bindings for Analog Devices as3645a flash LED controller which also supports an indicator LED. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Acked-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: uapi book: Fix a few Sphinx warningsMauro Carvalho Chehab2017-08-272-2/+2
| | | | | | | | | | | Solve the following issues: Documentation/media/uapi/v4l/dev-sliced-vbi.rst:208: ERROR: Content block expected for the "raw" directive; none found. Documentation/media/uapi/v4l/dev-sliced-vbi.rst:216: ERROR: Content block expected for the "raw" directive; none found. Documentation/media/uapi/v4l/pixfmt-packed-rgb.rst:645: ERROR: Content block expected for the "raw" directive; none found. Fixes: 70b074df4ed1 ("media: fix pdf build with Spinx 1.6") Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: fix pdf build with Spinx 1.6Mauro Carvalho Chehab2017-08-2720-167/+202
| | | | | | | | | | | | | | | | | | | | | | Sphinx 1.6 generates some LaTeX code before each table, starting its own environment before calling tabulary, apparently to improve table layout. The problem is that such environment is incompatible with adjustbox. While, in thesis, it should be possible to override it or to redefine tabulary, I was unable to produce such patch. Also, that would likely break on some future Sphinx version. So, instead, let's just change the font size on bigger tables, in order for them to fit into the page size. That is not as good as adjustbox, and require some manual work, but it should be less sensitive to Sphinx changes. While here, adjust a few other tables whose text is exceeding the cell boundaries. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: doc: media/v4l-drivers/qcom_camss: Add abbreviations explanationTodor Tomov2017-08-261-5/+6
| | | | | | | | | Add explanations for VFE's PIX and RDI interfaces. Signed-off-by: Todor Tomov <todor.tomov@linaro.org> Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: doc: media/v4l-drivers: Qualcomm Camera Subsystem - Media graphTodor Tomov2017-08-262-17/+51
| | | | | | | | | Update the Qualcomm Camera Subsystem driver document with a media controller pipeline graph diagram. Signed-off-by: Todor Tomov <todor.tomov@linaro.org> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: doc: media/v4l-drivers: Qualcomm Camera Subsystem - Scale and cropTodor Tomov2017-08-261-1/+13
| | | | | | | | | Update the Qualcomm Camera Subsystem driver document for VFE scale and crop modules support. Signed-off-by: Todor Tomov <todor.tomov@linaro.org> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: doc: media/v4l-drivers: Qualcomm Camera Subsystem - PIX InterfaceTodor Tomov2017-08-261-10/+36
| | | | | | | | | Update Qualcomm Camera Subsystem driver document for the PIX interface and format conversion support. Signed-off-by: Todor Tomov <todor.tomov@linaro.org> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: doc: media/v4l-drivers: Add Qualcomm Camera Subsystem driver documentTodor Tomov2017-08-261-0/+124
| | | | | | | | Add a document to describe Qualcomm Camera Subsystem driver. Signed-off-by: Todor Tomov <todor.tomov@linaro.org> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt-bindings: media: Binding document for Qualcomm Camera subsystem driverTodor Tomov2017-08-261-0/+197
| | | | | | | | | | | Add DT binding document for Qualcomm Camera subsystem driver. CC: Rob Herring <robh+dt@kernel.org> CC: devicetree@vger.kernel.org Signed-off-by: Todor Tomov <todor.tomov@linaro.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: v4l: Add packed Bayer raw12 pixel formatsSakari Ailus2017-08-262-0/+104
| | | | | | | | | | | | | | | These formats are compressed 12-bit raw bayer formats with four different pixel orders. They are similar to 10-bit variants. The formats added by this patch are V4L2_PIX_FMT_SBGGR12P V4L2_PIX_FMT_SGBRG12P V4L2_PIX_FMT_SGRBG12P V4L2_PIX_FMT_SRGGB12P Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt-bindings: Add bindings for Dongwoon DW9714 voice coilSakari Ailus2017-08-262-0/+10
| | | | | | | | | | Dongwoon DW9714 is a voice coil lens driver. Also add a vendor prefix for Dongwoon for one did not exist previously. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt-bindings: add bindings document for zx-irdecShawn Guo2017-08-201-0/+14
| | | | | | | | | | It adds the dt-bindings document for ZTE ZX IRDEC remote control block. Signed-off-by: Shawn Guo <shawn.guo@linaro.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt-bindings: gpio-ir-tx: add support for GPIO IR TransmitterSean Young2017-08-201-0/+14
| | | | | | | | | Document the device tree bindings for the GPIO IR Bit Banging Transmitter. Signed-off-by: Sean Young <sean@mess.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt-bindings: pwm-ir-tx: Add support for PWM IR TransmitterSean Young2017-08-201-0/+13
| | | | | | | | Document the device tree bindings for the PWM IR Transmitter. Signed-off-by: Sean Young <sean@mess.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt-bindings: media: mtk-cir: Add support for MT7622 SoCSean Wang2017-08-201-2/+6
| | | | | | | | | | Document the devicetree bindings for CIR on MediaTek MT7622 SoC. Signed-off-by: Sean Wang <sean.wang@mediatek.com> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Sean Young <sean@mess.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: cec: rename pin events/functionHans Verkuil2017-08-203-6/+6
| | | | | | | | | | | | The CEC_EVENT_PIN_LOW/HIGH defines and the cec_queue_pin_event() function did not specify that these were about CEC pin events. Since in the future there will also be HPD pin events it is wise to rename the event defines and function to CEC_EVENT_PIN_CEC_LOW/HIGH and cec_queue_pin_cec_event() now before these become part of the ABI. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dt-bindings: media: Add Amlogic Meson AO-CEC bindingsNeil Armstrong2017-08-091-0/+28
| | | | | | | | | | The Amlogic SoCs embeds a standalone CEC Controller, this patch adds this device bindings. Signed-off-by: Neil Armstrong <narmstrong@baylibre.com> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: cec-ioc-g-mode.rst: improve description of message, processingHans Verkuil2017-08-091-24/+37
| | | | | | | | | | | | The description of how messages are processed by the core was not always very clear. Reword it to improve this. In particular for the USER_CONTROL_* messages a critical bit was missing in that the core also checks for the CEC_LOG_ADDRS_FL_ALLOW_RC_PASSTHRU flag. This was confusing. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-28 14:52:22 +0100