summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb
Commit message (Collapse)AuthorAgeFilesLines
* media: update/fix my e-mail on some placesMauro Carvalho Chehab2018-05-101-1/+1
| | | | | | | | | | | | There are two places pointing to an unexisting "m.chehab@kernel.org" email. I never had such email, so, I'm unsure how it ends there. Anyway, it is plain wrong. While here, use my canonical e-mail on a bunch of places that are pointing to another e-mail. The idea is that, from now on, all places will be pointing to the same SMTP server. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
* media: dvb: add continuity error indicators for memory mapped buffersMauro Carvalho Chehab2018-02-231-3/+4
| | | | | | | | | | While userspace can detect discontinuity errors, it is useful to also let Kernelspace reporting discontinuity, as it can help to identify if the data loss happened either at Kernel or userspace side. Update documentation accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb-core: get rid of mmap reserved fieldMauro Carvalho Chehab2017-12-284-8/+0
| | | | | | | | | The "reserved" field was a way, used at V4L2 API, to add new data to existing structs without breaking userspace. However, there are now clever ways of doing that, without needing to add an uneeded overhead. So, get rid of them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uAPI docs: document mmap-related ioctlsMauro Carvalho Chehab2017-12-285-0/+320
| | | | | | | 5 new ioctls were added to the DVB demux API, in order to handle memory maped I/O. Add documentation for them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uAPI docs: document demux mmap/munmap syscallsMauro Carvalho Chehab2017-12-283-0/+172
| | | | | | | | | With the new dmx mmap interface, those two syscalls are now handled by the subsystem. Document them. This patch is based on the V4L2 text for those ioctls. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb_frontend: add physical layer scrambling supportAthanasios Oikonomou2017-12-192-0/+20
| | | | | | | | | | | | | | | | | | | This commit adds a new property DTV_SCRAMBLING_SEQUENCE_INDEX. This 18 bit field, when present, carries the index of the DVB-S2 physical layer scrambling sequence as defined in clause 5.5.4 of EN 302 307. There is no explicit signalling method to convey scrambling sequence index to the receiver. If S2 satellite delivery system descriptor is available it can be used to read the scrambling sequence index (EN 300 468 table 41). By default, gold scrambling sequence index 0 is used. The valid scrambling sequence index range is from 0 to 262142. Increase the DVB API version in order userspace to be aware of the changes. Signed-off-by: Athanasios Oikonomou <athoik@gmail.com> Acked-by: Ralph Metzler <rjkm@metzlerbros.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uAPI docs: get rid of examples sectionMauro Carvalho Chehab2017-10-111-372/+6
| | | | | | | | | | | That section is too outdated and got superseded by DVBv5 and by libdvbv5. Maybe some day we'll end adding updated examples there, but while nobody has time or interest of doing that, just mention that there and get rid of the current examples for good. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb-net.rst: document DVB network kAPI interfaceMauro Carvalho Chehab2017-10-111-1/+1
| | | | | | That's the last DVB kAPI that misses documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb_frontend: fix return values for FE_SET_PROPERTYMauro Carvalho Chehab2017-10-111-2/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are several problems with regards to the return of FE_SET_PROPERTY. The original idea were to return per-property return codes via tvp->result field, and to return an updated set of values. However, that never worked. What's actually implemented is: - the FE_SET_PROPERTY implementation doesn't call .get_frontend callback in order to get the actual parameters after return; - the tvp->result field is only filled if there's no error. So, it is always filled with zero; - FE_SET_PROPERTY doesn't call memdup_user() nor any other copy_to_user() function. So, any changes to the properties will be lost; - FE_SET_PROPERTY is declared as a write-only ioctl (IOW). While we could fix the above, it could cause regressions. So, let's just assume what the code really does, updating the documentation accordingly and removing the logic that would update the discarded tvp->result. Reviewed-by: Shuah Khan <shuahkh@osg.samsung.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uapi: move frontend legacy API to another part of the bookMauro Carvalho Chehab2017-09-052-8/+14
| | | | | | | There's a chapter for the legacy APIs. Move the frontend DVBv3 API to it, and update the chapter's introduction accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: docs: don't show ToC for each part on PDF outputMauro Carvalho Chehab2017-09-051-1/+3
| | | | | | | | | | The "Table of Contents" of a PDF file is generated only once, at the beginning fo the output. It doesn't produce it on each part. So, don't output this text on each part of the document. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca.h: document ca_msg and the corresponding ioctlsMauro Carvalho Chehab2017-09-052-14/+11
| | | | | | | | | | | | Usually, CA messages are sent/received via reading/writing at the CA device node. However, two drivers (dst_ca and firedtv-ci) also implement it via ioctls. Apparently, on both cases, the net result is the same. Anyway, let's document it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca docs: document CA_SET_DESCR ioctl and structsMauro Carvalho Chehab2017-09-051-13/+2
| | | | | | | | | | The av7110 driver uses CA_SET_DESCR to store the descrambler control words at the CA descrambler slots. Document it. Thanks-to: Honza Petrouš <jpetrous@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: net.h: add kernel-doc and use it at Documentation/Mauro Carvalho Chehab2017-09-053-34/+10
| | | | | | | | | | As we did with frontend.h, ca.h and dmx.h, move the struct definition to net.h. That should help to keep it updated, as more stuff gets added there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: intro.rst: don't assume audio and video codecs to be MPEG2Mauro Carvalho Chehab2017-09-051-5/+4
| | | | | | | | Originally, when DVB was introduced, all codecs would be part of MPEG2 standard. That's not true anymore, as there are a large number of codec standards used on digital TV nowadays. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvbstb.svg: use dots for the optional parts of the hardwareMauro Carvalho Chehab2017-09-051-16/+15
| | | | | | | The hardware description mentions that some parts are optional. Make it clearer at the drawing. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dmx-get-pes-pids.rst: document the ioctlMauro Carvalho Chehab2017-09-051-2/+20
| | | | | | | | | This ioctl is supported by the DVB core, but was never documented. Add a documentation for it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uAPI docs: minor editorial changesMauro Carvalho Chehab2017-09-0516-52/+59
| | | | | | | | | | | | | Do minor editorial changes to improve documentation readability: - mark literals as such; - add table markups to hint sizes; - define what PES means; - instead of hardcoding devnode numbers to zero (like adapter0/) use a question mark, to indicate that multiple devnodes may exist; - add cross-references where useful. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvbapi.rst: add an entry to DVB revision historyMauro Carvalho Chehab2017-09-051-1/+6
| | | | | | | There are several missing items at the API history. Yet, as we're doing a significant change there, add a new entry. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb-frontend-parameters.rst: fix the name of a structMauro Carvalho Chehab2017-09-051-1/+1
| | | | | | | | | The struct that contains an union of DVB parameters is called dvb_frontend_parameters (and not FrontendParameters). Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dmx-fread.rst: specify how DMX_CHECK_CRC worksMauro Carvalho Chehab2017-09-051-0/+7
| | | | | | | | | | In the past, the documentation used to say that, if a CRC error was found, a "-ECRC" error would be returned. That's not true: the DVB core will just silently ignore such errors. So, add an explicit note about that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uAPI docs: Prefer use "Digital TV instead of "DVB"Mauro Carvalho Chehab2017-09-0541-126/+149
| | | | | | | | | | | The usage of the term "DVB" at the dvb API docs is confusing, as, right now, it can refer to either the European digital TV standard or to the subsystem. So, prefer calling it as "Digital TV" on most places, to avoid ambiguity. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: ca-fopen.rst: Fixes the device node name for CAMauro Carvalho Chehab2017-09-051-2/+2
| | | | | | | | | | The device node name for CA is wrong since ever. I suspect that the name there was before DVBv3 (with was the first API introduced at the Kernel). Anyway, use the right name there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: dvb uAPI docs: adjust return value ioctl descriptionsMauro Carvalho Chehab2017-09-0545-221/+327
| | | | | | | | | | | | | | | There are several issues on the return value for ioctls: - Text is confusing; - Some error codes don't exist; - The non-generic error codes should come before the text that points to the generic error codes; - Tables don't contain column size hints; - Some references are not marked as such. Correct 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-053-75/+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-051-172/+1
| | | | | | | | | | | 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-053-65/+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-053-54/+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-051-1/+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-0515-1845/+134
| | | | | | | | | | | 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>
OpenPOWER on IntegriCloud