summaryrefslogtreecommitdiffstats
path: root/Documentation/media
Commit message (Collapse)AuthorAgeFilesLines
* media: add qcom_camss.rst to v4l-drivers rst fileMauro Carvalho Chehab2017-09-051-0/+1
| | | | | | | Avoid this warning: /devel/v4l/docs/Documentation/media/v4l-drivers/qcom_camss.rst:: WARNING: document isn't included in any toctree 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: pixfmt-srggb12p.rst: better format the table for PDF outputMauro Carvalho Chehab2017-09-051-38/+21
| | | | | | | | Adjust the table to be better displayed on PDF output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: docs-rst: media: Don't use \small for V4L2_PIX_FMT_SRGGB10 documentationSakari Ailus2017-09-051-10/+5
| | | | | | | | | | | | | | There appears to be an issue in using \small in certain cases on Sphinx 1.4 and 1.5. Other format documents don't use \small either, remove it from here as well. Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> [mchehab@s-opensource.com: kept tabularcolumns - readjusted - and add a few blank lines for it to display better] Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: index.rst: don't write "Contents:" on PDF outputMauro Carvalho Chehab2017-09-051-1/+5
| | | | | | | | | | | Right now, Sphinx unconditionally creates a blank page with just "Contents:" on it, on PDF output. While this makes sense for html, it doesn't o PDF, as LaTeX does what's required automatically. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: pixfmt*.rst: replace a two dots by a commaMauro Carvalho Chehab2017-09-0517-17/+17
| | | | | | | | | | | | | | | On several tables, the color sample location table preamble is written as: Color Sample Location.. Instead of: Color Sample Location: I suspect that the repetition of such pattern was due to some copy-and-paste (or perhaps some error during DocBook conversion). Anyway, fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: vidioc-g-fmt.rst: adjust table formatMauro Carvalho Chehab2017-09-051-1/+1
| | | | | | | | | | | While doing a visual inspection with Sphinx 1.5, I noticed that one of the columns was smaller than the text written there. As this is the only thing I noticed with Sphinx 1.5, I suspect that this was also a problem with Sphinx 1.4. Yet, I opted to touch it in a way that wouldn't cause backward issues. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: vivid.rst: add a blank line to correct ReST formatMauro Carvalho Chehab2017-09-051-0/+1
| | | | | | | | | | | | On all vivid parameters, there's an space after the parameter, except for "DV Timings Signal Mode". That makes this single one to be written in bold, and, at PDF output, at the same line as its description. Use the same convention as the other parameters, in order to adjust its output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: v4l2 uapi book: get rid of driver programming's chapterMauro Carvalho Chehab2017-09-052-10/+0
| | | | | | | | | | It doesn't make any sense having a driver programming's chapter at the uAPI book, as this is related to kernel API. Also, we now have such kAPI book where V4L2 driver programming is covered. So, get rid of this left-over. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: format.rst: use the right markup for important notesMauro Carvalho Chehab2017-09-051-1/+1
| | | | | | | | There's an important note there, but it is not using the ReST markup. So, it doesn't get any visual highlight on the output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: docs-rst: cardlists: change their format to flat-tablesMauro Carvalho Chehab2017-09-0510-790/+3101
| | | | | | | | | | | | | | | | | | | | Most tables there don't fit on 80 columns. Some are very big. While those tables are actually generated via scripts, every time a new board is added, the entire table could be reformatted. >From the diffstat PoV, that's bad, as it is hard to see what happened. One such example is at changeset 4868f6e1fce6 ("media: em28xx-cardlist.rst: update to reflect last changes"): The USB ID for "Plextor ConvertX PX-AV100U" was added to card number 9, with caused the entire table to be reformatted. So, instead, use flat-tables. While here, fix PDF output, by adding tablecolumns to the tables that need it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: em28xx-cardlist.rst: update to reflect last changesMauro Carvalho Chehab2017-09-051-104/+106
| | | | | | | There were some new board additions. Update the cardlist accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: v4l2-event.rst: adjust table to fit on PDF outputMauro Carvalho Chehab2017-09-051-0/+2
| | | | | | | | The tables there don't quite fit on PDF output. Adjust it by adding a tabularcolumns macro. 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-0510-10/+31
| | | | | | | | | | 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: cec uapi: Adjust table sizes for PDF outputMauro Carvalho Chehab2017-09-054-6/+14
| | | | | | | Several tables at this media book chapter have issues when PDF is produced. Adjust them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: mc uapi: adjust some table sizes for PDF outputMauro Carvalho Chehab2017-09-053-3/+3
| | | | | | | | Some cells are too small to fit the text written to it. Increase it. No text changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: rc-sysfs-nodes.rst: better use literalsMauro Carvalho Chehab2017-09-051-5/+5
| | | | | | | | | | | | A literal box provides a better visual when pdf and html output is generated for things like the output of a sysfs devnode. It alsod matches other conventions used within the media book. So, use it. While here, use literals for protocol names. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: docs: fix PDF build with Sphinx 1.4Mauro Carvalho Chehab2017-09-052-3/+6
| | | | | | | | | | | | | | | | | | | | | | | | Commit 70b074df4ed1 ("media: fix pdf build with Spinx 1.6") caused a regression at Sphinx 1.4 PDF build: although it produces a full document in batch mode, it returns errors on interactive mode: [63] Runaway argument? {\relax ! Paragraph ended before \multicolumn was complete. <to be read again> \par l.7703 \hline\end{tabulary} The error seems to be due to some bug at Sphinx PDF output: when multicolumns is used, it doesn't accept an empty string. Just removing the :cpan:`1` and replacing by two empty columns fix the issue. Fixes: 70b074df4ed1 ("media: fix pdf build with Spinx 1.6") Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: v4l uAPI docs: adjust some tables for PDF outputMauro Carvalho Chehab2017-09-055-4/+8
| | | | | | | | | | | On tests with Spinx 1.4, some tables are still writing text outside cells. Adjust those tables. PS.: As this was revisited several times, I suspect that this will only be fully fixed if we add tabularcolumns to all tables at the V4L2 part of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: vidioc-g-tuner.rst: Fix table number of colsMauro Carvalho Chehab2017-09-051-3/+6
| | | | | | | | | | The Tuner Audio Matrix table is broken: the first row has 7 columns instead of 6, causing it to be parsed wrong and displayed very badly on PDF output. Fix it and adjust the table to look nice at PDF output Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: vidioc-querycap: use a more realistic value for KERNEL_VERSIONMauro Carvalho Chehab2017-09-051-2/+3
| | | | | | | | | | | | | In the past, V4L2 versions were 0.x.y, but that changed years ago. Since Kernel 3.1, however, the numbering schema was changed to match the Kernel version. However, the presented example still uses the old numerating schema, with is a misleading information. So, update it to the new schema. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* media: v4l uAPI: add descriptions for arguments to all ioctlsMauro Carvalho Chehab2017-09-0558-12/+60
| | | | | | | | | | | Several ioctls are missing descriptions for the third argument of the ioctl() command. They should have a description, as otherwise the output won't be ok, and will sound like something is missing. So, add them. 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: 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-03 13:39:41 +0000