aboutsummaryrefslogtreecommitdiff
path: root/Documentation/userspace-api/media/dvb
AgeCommit message (Collapse)AuthorFilesLines
2024-04-08media: docs: Remove the repeated word "the" in docs.hanchunchao1-1/+1
Fix "The the" typo in the documentation. Signed-off-by: hanchunchao <[email protected]> Signed-off-by: Hans Verkuil <[email protected]> [hverkuil: added commit log]
2024-02-07media: docs: uAPI: dvb/decoder: completing the documentationStefan Herdler2-0/+62
The existing documentation of the legacy DVB Decoder API was incomplete. Revising the documentation, adding missing parts and arranging the documentation files new. This patch contains the new index file and links to it. Link: https://lore.kernel.org/linux-media/[email protected] Signed-off-by: Stefan Herdler <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2024-02-07media: docs: uAPI: dvb/video: completing the documentation (function calls)Stefan Herdler1-0/+1632
The existing documentation of the legacy DVB Decoder API was incomplete. Revising the documentation, adding missing parts and arranging the documentation files new. This patch contains the documentation of the function calls defined in video.h. Link: https://lore.kernel.org/linux-media/[email protected] Signed-off-by: Stefan Herdler <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2024-02-07media: docs: uAPI: dvb/video: completing the documentation (data types)Stefan Herdler1-0/+798
The existing documentation of the legacy DVB Decoder API was incomplete. Revising the documentation, adding missing parts and arranging the documentation files new. This patch contains the documentation of the data types defined in video.h. Link: https://lore.kernel.org/linux-media/[email protected] Signed-off-by: Stefan Herdler <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2024-02-07media: docs: uAPI: dvb/audio: completing the documentation (function calls)Stefan Herdler1-0/+1195
The existing documentation of the legacy DVB Decoder API was incomplete. Revising the documentation, adding missing parts and arranging the documentation files new. This patch contains the documentation of the function calls defined in audio.h. Link: https://lore.kernel.org/linux-media/[email protected] Signed-off-by: Stefan Herdler <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2024-02-07media: docs: uAPI: dvb/audio: completing the documentation (data types)Stefan Herdler1-0/+447
The existing documentation of the legacy DVB Decoder API was incomplete. Revising the documentation, adding missing parts and arranging the documentation files new. This patch contains the documentation of the data types defined in audio.h. Link: https://lore.kernel.org/linux-media/[email protected] Signed-off-by: Stefan Herdler <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2024-02-07media: docs: uAPI: dvb/osd: completing the documentationStefan Herdler1-0/+883
The existing documentation of the legacy DVB Decoder API was incomplete. Revising the documentation, adding missing parts and arranging the documentation files new. This patch contains the documentation of osd.h. Link: https://lore.kernel.org/linux-media/[email protected] Signed-off-by: Stefan Herdler <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2023-11-17media: doc: properly format ToC headingsVegard Nossum1-6/+1
"class:: toc-title" was a workaround for older Sphinx versions that are no longer supported. The canonical way to add a heading to the ToC is to use :caption:. Do that. Cc: Mauro Carvalho Chehab <[email protected]> Cc: [email protected] Signed-off-by: Vegard Nossum <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
2022-11-25media: dvb: add DVB-C2 and DVB-S2X parameter valuesRobert Schlabbach1-9/+16
Extend the DVB frontend parameter enums with additional values specified by the DVB-C2 (ETSI EN 302 769) and DVB-S2X (ETSI EN 302 307-2) standards to be ready for frontend drivers for such receivers. While most parameters will be "read-only" due to being autodetected by the receiver and only being reported back for informational purposes, the addition of SYS_DVBC2 to the delivery systems enum is required, because there are DVB-C2 capable receivers which are not capable of DVB-C/C2 autodetection and thus need this enum value to be explicitly instructed to search for a DVB-C2 signal. As for DVB-S2X, as that is an extension to DVB-S2, the same delivery system enum as for DVB-S2 can be used. Add the additional enum values and comments to the documentation. Link: https://lore.kernel.org/linux-media/trinity-1b7c5a66-85d4-4595-a690-0fde965d49b3-1642146228587@3c-app-gmx-bap69 Signed-off-by: Robert Schlabbach <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-06-04media: docs: move DVB audio/video docs to stagingMauro Carvalho Chehab51-3314/+0
The only upstream driver using the API described there is the av7110 driver. As the driver was moved to staging, move the API bits to staging as well. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-06-02docs: userspace-api: media: dvb: replace some charactersMauro Carvalho Chehab7-9/+9
The conversion tools used during DocBook/LaTeX/html/Markdown->ReST conversion and some cut-and-pasted text contain some characters that aren't easily reachable on standard keyboards and/or could cause troubles when parsed by the documentation build system. Replace the occurences of the following characters: - U+00a0 (' '): NO-BREAK SPACE as it can cause lines being truncated on PDF output - U+2019 ('’'): RIGHT SINGLE QUOTATION MARK - U+201c ('“'): LEFT DOUBLE QUOTATION MARK - U+201d ('”'): RIGHT DOUBLE QUOTATION MARK Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-03-11media: docs: uAPI: fix table output in LaTeX/PDF formatMauro Carvalho Chehab1-1/+1
There are lots of tables that are not properly displayed in LaTeX/PDF. Fix the tablecolumns, add longtable where needed and LaTeX formatting macros, in order to address such issues. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2021-02-05media: media/dvb/dvbstb.svg: Antena -> AntennaHans Verkuil1-1/+1
Fix typo. Signed-off-by: Hans Verkuil <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation: userspace-api/media: dvb/audio: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "and". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation: userspace-api/media: dvb/net: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "and". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation: userspace-api/media: dvb/video: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "and". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation: userspace-api/media: dvb/dmx-qbuf: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "the". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation: userspace-api/media: dvb/demux: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "and". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-11-27media: Documentation: userspace-api/media: dvb/ca: drop doubled wordRandy Dunlap1-1/+1
Drop the doubled word "and". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-10-15media: docs: make DVB documents more compatible with Sphinx 3.1+Mauro Carvalho Chehab95-534/+329
Sphinx 3.x broke support for the cdomain.py extension, as the c domain code was rewritten. Due to that, the c tags need to be re-written, in order to use the new c domain notation. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-09-01media: docs: use SPDX GPL-2.0 OR GFDL-1.1 instead of text on *.svg filesMauro Carvalho Chehab1-27/+1
There are some files that are dual licensed GPL and GFDL. As SPDX v3.10 gained support for GFDL-1.1 with no invariant sections: https://spdx.org/licenses/GFDL-1.1-no-invariants-or-later.html Let's remove the dual license text, replacing them by: SPDX-License-Identifier: GPL-2.0 OR GFDL-1.1-no-invariants-or-later Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-09-01media: docs: use the new SPDX header for GFDL-1.1 on *.rst filesMauro Carvalho Chehab131-1049/+131
SPDX v3.10 gained support for GFDL-1.1 with no invariant sections: https://spdx.org/licenses/GFDL-1.1-no-invariants-or-later.html So, remove the license text, replacing them by this new SPDX license. Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-07-19Documentation: userspace-api/media: drop doubled wordsRandy Dunlap1-2/+1
Drop duplicated words in Documentation/userspace-api/media/. This addresses the words "struct" and "value". Signed-off-by: Randy Dunlap <[email protected]> Cc: Jonathan Corbet <[email protected]> Signed-off-by: Hans Verkuil <[email protected]> [[email protected]: dev-sdr.rst: there is two -> there are two] Signed-off-by: Mauro Carvalho Chehab <[email protected]>
2020-04-14media: docs: move uAPI book to userspace-api/mediaMauro Carvalho Chehab133-0/+10542
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 <[email protected]>