summaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook (follow)
Commit message (Collapse)AuthorAgeFilesLines
* [media] DocBook: Add an example for using FE_SET_PROPERTYMauro Carvalho Chehab2015-05-301-0/+40
| | | | | | | | | | In order to make it clearer about how to use the DVBv5 calls, add an example of its usage. That should make it clearer about what's actually required for the DVBv5 calls to work. While here, also mentions the libdvbv5 library. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation of the properties structsMauro Carvalho Chehab2015-05-302-9/+9
| | | | | | | Rename the tytle of the struct documentation to reflect the name of the structures, and use links to do cross-ref. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for hierarchyMauro Carvalho Chehab2015-05-303-28/+38
| | | | | | Format it as a table and links it with the legacy API xml. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for guard intervalMauro Carvalho Chehab2015-05-303-32/+54
| | | | | | | Format it as a table and add more details, in special for DTMB guard intervals. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for FEC fieldsMauro Carvalho Chehab2015-05-303-85/+74
| | | | | | | Format it as a table and add more details. Also, remove the duplicated occurrences. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move fe_bandwidth to the frontend legacy sectionMauro Carvalho Chehab2015-05-302-16/+43
| | | | | | | fe_bandwidth/fe_bandwidth_t is used only on DVBv3 API. So, move it to the frontend legacy xml, and convert it into a table. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for OFDM transmission modeMauro Carvalho Chehab2015-05-303-31/+55
| | | | | | | Format it as a table and add more details, in special, for the DTMB modes. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for DVB spectral inversionMauro Carvalho Chehab2015-05-303-31/+40
| | | | | | Format it as a table and provide more details. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: cross-reference enum fe_modulation where neededMauro Carvalho Chehab2015-05-301-3/+3
| | | | | | | | At frontend legacy API description, there are three places where fe_modulation_t is defined. Cross-reference it to point to the right place at the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook/Makefile: improve typedef parserMauro Carvalho Chehab2015-05-301-2/+2
| | | | | | | | The typedef parser is wrong and doesn't get some of the types defined at the DVB API. Improve it, as we want to add cross-references to those types. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: some fixes at FE_GET_INFOMauro Carvalho Chehab2015-05-301-4/+5
| | | | | | | | | | | There are a few issues at FE_GET_INFO documentation: - name is a string, not a pointer to a string; - the return text should be after the paragraph. While here, better to bold that two fields of the structure used by FE_GET_INFO are actually deprecated. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Better document enum fe_modulationMauro Carvalho Chehab2015-05-302-45/+72
| | | | | | | Instead of using programlisting, use a table, as this provides a better view of the structure. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add a proper description for dvb_frontend_info.fe_typeMauro Carvalho Chehab2015-05-301-3/+13
| | | | | | | | | | | | The fe_type is deprecated at the DVB API. However, it may still be used by legacy DVBv3 applications. While this works with old devices, modern devices may support more than one delivery system. Add an explanation about that and a point to what should be used, instead, in order for legacy apps to support newer hardware. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Provide a high-level description for DVB frontendMauro Carvalho Chehab2015-05-301-6/+16
| | | | | | | Instead of just showing ioctls, let's add an introdutory text briefly explaining the DVB frontend API. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix FE_READ_STATUS argument descriptionMauro Carvalho Chehab2015-05-301-8/+12
| | | | | | | | | | | | | | | | What's written there about the arguments for this ioctl is bogus: it doesn't return an enum (or a typedef) for enum fe_status. Instead, it returns a bitmask with the values defined by enum fe_status. Also, the size of the integer returned is not 16 bits, but, instead, sizeof(fe_status_t), e. g. sizeof(enum), with is arch-dependent. This should of course be fixed, but this should be done on a separate patch. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better organize the function descriptions for frontendMauro Carvalho Chehab2015-05-302-6/+3
| | | | | | | | | | | | | | | | | | | | | | Move the function ioctl definitions to the end of the chapter, at their importance. That makes the document better organized, as the DVB frontend system call index will look like: open() close() ioctl FE_GET_INFO — Query DVB frontend capabilities and returns information about the front-end. This call only requires read-only access to the device ioctl FE_READ_STATUS — Returns status information about the front-end. This call only requires read-only access to the device ioctl FE_SET_PROPERTY, FE_GET_PROPERTY — FE_SET_PROPERTY sets one or more frontend properties. FE_GET_PROPERTY returns one or more frontend properties. ioctl FE_DISEQC_RESET_OVERLOAD — Restores the power to the antenna subsystem, if it was powered off due to power overload. ioctl FE_DISEQC_SEND_MASTER_CMD — Sends a DiSEqC command ioctl FE_DISEQC_RECV_SLAVE_REPLY — Receives reply from a DiSEqC 2.0 command ioctl FE_DISEQC_SEND_BURST — Sends a 22KHz tone burst for 2x1 mini DiSEqC satellite selection. ioctl FE_SET_TONE — Sets/resets the generation of the continuous 22kHz tone. ioctl FE_SET_VOLTAGE — Allow setting the DC level sent to the antenna subsystem. ioctl FE_ENABLE_HIGH_LNB_VOLTAGE — Select output DC level between normal LNBf voltages or higher LNBf voltages. ioctl FE_SET_FRONTEND_TUNE_MODE — Allow setting tuner mode flags to the frontend. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_RESET_OVERLOADMauro Carvalho Chehab2015-05-302-44/+52
| | | | | | | Use the new format for the ioctl documentation and put the struct dvb_diseqc_slave_reply together with the ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_SEND_MASTER_CMDMauro Carvalho Chehab2015-05-302-62/+73
| | | | | | | Use the new format for the ioctl documentation and put the struct dvb_diseqc_slave_reply together with the ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_RECV_SLAVE_REPLYMauro Carvalho Chehab2015-05-302-63/+79
| | | | | | | Use the new format for the ioctl documentation and put the struct dvb_diseqc_slave_reply together with the ioctl. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_DISEQC_SEND_BURST ioctlMauro Carvalho Chehab2015-05-302-66/+87
| | | | | | | | | | Use the proper format for FE_DISEQC_SEND_BURST documentation and improve the documentation. Keep the enum fe_sec_mini_cmd description together with the ioctl, as both are used together. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_SET_TONE ioctlMauro Carvalho Chehab2015-05-302-60/+89
| | | | | | | | | | Use the proper format for FE_SET_TONE documentation and improve the documentation. Keep the enum fe_sec_tone_mode description together with the ioctl, as both are used together. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: better document FE_SET_VOLTAGE ioctlMauro Carvalho Chehab2015-05-302-61/+95
| | | | | | | | | | | Use the proper format for FE_SET_VOLTAGE documentation and fix the documentation. The description for the enum is not 100%, and it is missing the voltage off value. Also, it is better to keep the enum description together with the ioctl, as both are used together. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: reformat FE_ENABLE_HIGH_LNB_VOLTAGE ioctlMauro Carvalho Chehab2015-05-302-49/+62
| | | | | | Use the proper format for FE_ENABLE_HIGH_LNB_VOLTAGE documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: reformat FE_SET_FRONTEND_TUNE_MODE ioctlMauro Carvalho Chehab2015-05-302-31/+65
| | | | | | Use the proper format for FE_SET_FRONTEND_TUNE_MODE documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move FE_GET_PROPERTY to its own xml fileMauro Carvalho Chehab2015-05-302-82/+83
| | | | | | | | That helps the xref logic at the Makefile to point to the right place. Also, it becomes more organized and easier to maintain if each ioctl have its own xml file. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Rename ioctl xml filesMauro Carvalho Chehab2015-05-303-2/+2
| | | | | | | for the xml files describing ioctls, use the same nomenclature as on V4L2: the ioctl name, in lower case, using - instead of _. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Fix false positive undefined ioctl referencesMauro Carvalho Chehab2015-05-306-6/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | The new code that detects undocumented ioctls hits some false positives: This one is not documented, nor it should, as this is there just to reserve namespace: Warning: can't find reference for VIDIOC_RESERVED ioctl But those are already documented together with other ioctls: Warning: can't find reference for VIDIOC_UNSUBSCRIBE_EVENT ioctl Warning: can't find reference for FE_GET_PROPERTY ioctl Warning: can't find reference for VIDIOC_SUBDEV_G_EDID ioctl Warning: can't find reference for VIDIOC_SUBDEV_S_EDID ioctl Warning: can't find reference for VIDIOC_SUBDEV_S_DV_TIMINGS ioctl Warning: can't find reference for VIDIOC_SUBDEV_G_DV_TIMINGS ioctl Warning: can't find reference for VIDIOC_SUBDEV_QUERY_DV_TIMINGS ioctl So, we need to just be sure to point to the right documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: remove duplicated ioctl from v4l2-subdevMauro Carvalho Chehab2015-05-301-7/+0
| | | | | | | Those ioctls are already parsed. No need to explicitly add them. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Improve xref check for undocumented ioctlsMauro Carvalho Chehab2015-05-301-3/+5
| | | | | | | | | There are several badly documented undocumented ioctls. Currently, it just generates an empty link. Instead of doing that, only add references to the ones that exists, and add a warning for all references that weren't found. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Add xref links for DTV propetiesMauro Carvalho Chehab2015-05-302-6/+20
| | | | | | | Create xref links for all DTV properties and link the frontend.h to each. Also use them at the DVB frontent API example. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Improve the description of the properties APIMauro Carvalho Chehab2015-05-301-5/+32
| | | | | | Make the text clearer about what the properties API does. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Merge FE_SET_PROPERTY/FE_GET_PROPERTY ioctl descriptionMauro Carvalho Chehab2015-05-303-72/+36
| | | | | | | | | | Instead of having two refentries, merge them into just one, like what's done with other similar ioctls at V4L2 side. That makes the entry cleaner and will allow to add the associated structures together with the refentry. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix xref to the FE open() functionMauro Carvalho Chehab2015-05-304-4/+5
| | | | | | | | Instead of going to the V4L2 open(), use the xref to the proper place at the frontend ioctls that were already reformatted. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: rewrite FE_GET_PROPERTY/FE_SET_PROPERTY to use the std wayMauro Carvalho Chehab2015-05-301-96/+118
| | | | | | | Use the standard way of documenting ioctls for FE_GET_PROPERTY and FE_SET_PROPERTY. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move DVB properties to happen earlier at the documentMauro Carvalho Chehab2015-05-301-2/+2
| | | | | | | | The DVBv5 API uses DVB properties as the main way to set the frontend and collect statistics. Move the definition to happen earlier, in order to reflect its importance. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: improve documentation for FE_READ_STATUSMauro Carvalho Chehab2015-05-302-109/+113
| | | | | | | Move the ioctl and enum fe_status to a separate xml file and put it into a better format. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move FE_GET_INFO to a separate xml fileMauro Carvalho Chehab2015-05-302-265/+266
| | | | | | | | | | Keeping everything altogether makes harder to reorganize the DocBook. So, move the FE_GET_INFO ioctl and the associated structures into a separate file. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: reformat FE_GET_INFO ioctl documentationMauro Carvalho Chehab2015-05-301-107/+267
| | | | | | | | | | | | The DVB part of the docbook has a completely different format than the V4L2 part, as it was written as a separate document. As the V4L2 documentation is on better shape, and its format allows adding more information, let's use it for FE_GET_INFO and gradually update the non-legacy DVB ioctls using the new format. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: move DVBv3 frontend bits to a separate sectionMauro Carvalho Chehab2015-05-302-590/+618
| | | | | | | | | | | | | | Although the recommended usage is the DVBv5 API calls, the documentation doesn't make it clear about what's the recommended calls and what's legacy. So, move the legacy API bits to a separate xml, putting them into a new section. Please notice that more changes are needed, since some of the bits there are cross-referenced elsewhere. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Improve DVB frontend descriptionMauro Carvalho Chehab2015-05-301-17/+29
| | | | | | The DVB frontend API got bitrotten. Update it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: fix emphasis at the DVB documentationMauro Carvalho Chehab2015-05-308-34/+34
| | | | | | | | | Currently, it is using 'role="tt"', but this is not defined at the DocBook 4.5 spec. The net result is that no emphasis happens. So, replace them to bold emphasis. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add drawing with a typical media deviceMauro Carvalho Chehab2015-05-304-2/+45
| | | | | | | | An illustration of what's considered a typical media device may help people to better understand the contents of the media infrastructure API docbook. So, add it. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: add a note about the ALSA APIMauro Carvalho Chehab2015-05-301-0/+3
| | | | | | | | The Docbook mistakenly makes to believe that all needed APIs for media devices are there. Add a note there pointing that some sub-devices are actually be controlled via ALSA API. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook: Update DVB supported standards at introductionMauro Carvalho Chehab2015-05-301-2/+3
| | | | | | | | | | | The list of standards at the media docbook is incomplete, and it is mentioning that the DVB-S2 & friends is "currently being updated". That's wrong, as such update occurred back in 2008. So, provide a more complete list of supported standards and add a reference to the actual list. Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook/media: fix syntax errorHans Verkuil2015-05-181-1/+3
| | | | | | | Missing varlistentry tags. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook/media: improve timestamp documentationHans Verkuil2015-05-181-1/+4
| | | | | | | Explain which clock was used to make the timestamp. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook/media: remove spurious spaceHans Verkuil2015-05-181-1/+1
| | | | | | | Looks ugly, a space before a period at the end of a sentence. Remove it. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] dvb: Document FE_SCALE_DECIBEL units consistentlyDavid Howells2015-05-141-2/+2
| | | | | | | | | | | | | | | In comments and in the documentation, the units of properties marked with the FE_SCALE_DECIBEL scale are specified in terms of 1/1000 dB or 0.0001 dB. This is inconsistent, however, as 1/1000 is 0.001, not 0.0001. Note that the v4l-utils divide the value by 1000 for the signal strength suggesting that the 1/1000 is correct. Settle on millidecibels, ie. 1/1000dB or 0.001dB. Signed-off-by: David Howells <dhowells@redhat.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook media: document codec draining flowPhilipp Zabel2015-05-124-2/+40
| | | | | | | | | | | | | | Document the interaction between VIDIOC_DECODER_CMD V4L2_DEC_CMD_STOP and VIDIOC_ENCODER_CMD V4L2_ENC_CMD_STOP to start the draining, the V4L2_EVENT_EOS event signalling all capture buffers are finished and ready to be dequeud, the new V4L2_BUF_FLAG_LAST buffer flag indicating the last buffer being dequeued from the capture queue, and the poll and VIDIOC_DQBUF ioctl return values once the queue is drained. Signed-off-by: Philipp Zabel <p.zabel@pengutronix.de> Acked-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Kamil Debski <k.debski@samsung.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
* [media] DocBook/media: Improve G_EDID specificationHans Verkuil2015-05-011-0/+7
| | | | | | | | | | | | | When using VIDIOC_G_EDID there is a special case where start_blocks and blocks are both set to 0. In that case the driver just has to set blocks to the total number of available blocks and return 0. Even though the drivers do this right and v4l2-compliance tests for it, it turned out not to be documented in the spec. Fix this. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Reported-by: Mats Randgaard <matrandg@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-17 19:43:04 +0100