summaryrefslogtreecommitdiff
path: root/Documentation/admin-guide/media
AgeCommit message (Collapse)AuthorFilesLines
2020-07-05Documentation/admin-guide: media/building: drop doubled wordsRandy Dunlap1-2/+2
Drop some doubled words. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: linux-media@vger.kernel.org Link: https://lore.kernel.org/r/20200704032020.21923-5-rdunlap@infradead.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-05-06media: ipu3.rst: fix a build warningMauro Carvalho Chehab1-1/+2
Sphinx 2.4.4 produces this warning: Documentation/admin-guide/media/ipu3.rst:235: WARNING: Title underline too short. Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-05-05media: admin-guide: split cardlist.rst fileMauro Carvalho Chehab7-707/+724
After adding all cardlists, this file became too big. Split it on smaller files, in order to make easier to maintain. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-05-05media: admin-guide: make clear about PCI subsystem IDsMauro Carvalho Chehab8-18/+25
On several parts of the document, it mentions "PCI ID", when it is actually referring to the subsystem's part of the PCI ID. Change the language to let it be clear. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-05-05media: ipu3.rst: add explanation for running modeBingbu Cao1-4/+23
Add some explanation of the ImgU running mode and add more information about firmware selection and running mode usage. Signed-off-by: Bingbu Cao <bingbu.cao@intel.com> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: split driver-specific indexes to new filesMauro Carvalho Chehab4-75/+63
In order to better organize the main admin-guide index, place the driver-specific indexes on separate files. This ensures a more consistent numbering at the main index. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: reorganize the guideMauro Carvalho Chehab3-23/+44
Separate the generic documentation from the driver-specific parts, and use a better title for the documentation. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: bt8xx.rst: fix a broken cross-referenceMauro Carvalho Chehab1-1/+1
The old cards.rst file doesn't exist anymore. Also, it is not the right reference there, as it should be pointing to the bttv-specific cardlist. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add test-driversMauro Carvalho Chehab1-0/+16
While test drivers is probably something that normal users won't bother, it doesn't hurt to add them to the card list. This way, all drivers, except for the ones under staging, would be listed there. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add card lists for radio and firewireMauro Carvalho Chehab1-0/+54
Document the supported radio devices, plus document the firewire driver. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add SPI cards to platform driversMauro Carvalho Chehab1-0/+9
The SPI cards are also under the concept of "platform" drivers as defined at the section introduction. So, add a SPI card list there. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a list of I2C driversMauro Carvalho Chehab1-0/+267
For completeness, let's add a list of I2C drivers. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a list of platform driversMauro Carvalho Chehab1-5/+81
There's no reason why to keep platform drivers out of the card list. Add them. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a table with USB driversMauro Carvalho Chehab1-0/+78
Having a table with a list of all USB drivers seems worth, and it comes almost for free, as we can just use Kconfig descriptions (with some adjustments). So, add a table for that. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a list of media PCI cardsMauro Carvalho Chehab2-27/+48
Instead of listing "other" PCI card list, just add a list with the existing drivers (not including sub-drivers). Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: replace the frontend drivers listMauro Carvalho Chehab1-33/+211
The frontend drivers list is incomplete. Update it from what's there at the Kernel Kconfig files. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: split DVB cards.rstMauro Carvalho Chehab5-148/+79
The DVB cards.rst file is old and outdated. It also contains data that are contained on other cardlists. Remove the duplicated information and split frontends and PCI cards on separate files. As all USB cards already have their own card lists, just drop the old USB data there. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a cardlist for all other USB cardsMauro Carvalho Chehab2-0/+94
There are several other USB cards. Most of them support just one device. The only exception is the "pwc" driver. But, as updates to it are not frequent, let's just place everything manually into a single file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a card list for the Siano driverMauro Carvalho Chehab2-0/+58
The siano driver looks like em28xx, except that its cards are split on 3 drivers. Add a card list for it. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add support for the remaining dvb-usb boardsMauro Carvalho Chehab20-1/+432
Add documentation for the remaining dvb-usb boards. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add dibusb-mb and dibusb-mc card listsMauro Carvalho Chehab3-0/+74
Document the supported dib0300 boards. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add cardlist for dib0700 driverMauro Carvalho Chehab2-0/+164
Document the cards supported by dib0700 driver. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add dvb-usb-v2 card listsMauro Carvalho Chehab14-0/+469
Include cardlist documentation for the sub-drivers supported by dvb-usb-v2 core. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: improve cardlist.rst documentationMauro Carvalho Chehab1-5/+111
The cardlist section is important for some boards, because they may require extra modprobe parameters. Improve the docs to mention that. Thanks-to: Hans Verkuil <hverkuil-cisco@xs4all.nl> # for providing me some PCI IDs Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a generic building guideMauro Carvalho Chehab2-0/+358
Several of the existing documents under the media admin-guide contain build procedures. Add an specific chapter describing it. This document was partially inspired on the modifications I made to the bttv.rst file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: Add an introduction chapterMauro Carvalho Chehab2-0/+29
The media's admin guide is currently just a group of not-connected docs. Add an introduction chapter for it to start making sense to a random reader. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: update em28xx cardlistMauro Carvalho Chehab1-0/+4
A new em28xx card was added upstream. Update cards list accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22media: admin-guide: add a card list for cx231xx boardsMauro Carvalho Chehab2-0/+100
It is interesting to have a card list also for cx231xx driver, as it currently supports 27 different boards. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-21media: imx.rst: Provide streaming examples for imx6q-sabresdFabio Estevam1-0/+45
Improve the documentation by providing examples on how to test camera capture on imx6q-sabresd via v4l2-ctl and Gstreamer. Signed-off-by: Fabio Estevam <festevam@gmail.com> Reviewed-by: Steve Longerbeam<slongerbeam@gmail.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-21media: imx.rst: Provide the OV560 module part numberFabio Estevam1-2/+2
In order to improve the documentation, provide the OV5640 MIPI module part number that is used on the imx6q-sabresd board. Signed-off-by: Fabio Estevam <festevam@gmail.com> Reviewed-by: Steve Longerbeam <slongerbeam@gmail.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-21media: imx.rst: Provide an example for unprocessed video captureFabio Estevam1-0/+20
The current example for imx6q-sabresd is for a direct conversion pipeline. Provide an extra example using unprocessed video capture for completeness. Signed-off-by: Fabio Estevam <festevam@gmail.com> Reviewed-by: Steve Longerbeam <slongerbeam@gmail.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-21media: imx.rst: Fix the MIPI CSI-2 virtual channelFabio Estevam1-16/+15
The current instructions for imx6q-sabresd do not lead to functional capture on OV5640 MIPI CSI-2. The reason for this, as explained by Steve Longerbeam, is that OV5640 by default transmits on virtual channel 0, not channel 1 as is given in the instructions. Adapt the instructions to use virtual channel 0 so that a working camera setup can be achieved on imx6q-sabresd. Also, since we are using an IC direct conversion pipeline, improve the example by demonstrating colorspace and scaling. Signed-off-by: Fabio Estevam <festevam@gmail.com> Reviewed-by: Steve Longerbeam<slongerbeam@gmail.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: add cros-references to the other media guidesMauro Carvalho Chehab1-0/+12
In order to make easier for people to navigate between the three media guides, add cross-references between them Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: move copyrights to the end and update themMauro Carvalho Chehab1-9/+16
The copyright info is not the most valuable information there. Move them to the end. While here, change the copyright to cover up to this year (2020). Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: get rid of obsoleted udev documentationMauro Carvalho Chehab3-66/+0
This file is very old, and doesn't match the current udev behavior. I wanted to preserve it, because we'll need some udev description some day about how to keep names unique, but there's nothing here to help with that... So, be it: let's just discard this document, as it doesn't provide anything useful anymore. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: zr364xx: update documentationMauro Carvalho Chehab1-18/+10
There aren't much to be done here... almost everything is still valid. The supported boards even reflect the current driver's state. Yet, some things changed, so let's keep this document updated. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: saa7134.rst: update the documentationMauro Carvalho Chehab1-15/+42
There are several things here that are outdated, because this document was written a long time ago. Update them to reflect the current status of the driver and the media subsystem. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: update Digital TV faq.rstMauro Carvalho Chehab1-103/+150
This file contains lots of obsoleted information. Update it to reflect the current status and tools used by Digital TV users and add pointers to the current locations and to LinuxTV wiki pages. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: cpia2.rst: do some cleanupsMauro Carvalho Chehab1-7/+3
Do some cleanups at the document in order to mark two literal blocks as such. While here, simplify two block markups, using the less verbose option (::). Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: add a cardlist for cx18 boardsMauro Carvalho Chehab2-0/+18
There aren't many boards supported by this driver. So, add a list for it manually generated. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: update bttv.rst informationMauro Carvalho Chehab1-184/+139
This document is... old. The bttv driver was one of the first drivers at the Kernel. So, the document became a little obsoleted. Update it to reflect some changes that happened along the time affecting this driver and the subsystem. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: bt8xx.rst: update document infoMauro Carvalho Chehab1-52/+86
This document is very outdated, and doesn't match the upstream current way. Update it, making some parts a little bit more generic. While the main focus of this document is digital TV cards, its content also may also help someone with just analog TV support. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: update avermedia.rst contentsMauro Carvalho Chehab1-5/+5
While this is old, now that we moved the intro part of it, its contents seem to be valid, if we mention that we're talking only about the BT878 support. Update the document title accordingly and remove the obsolete note from it. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: intro.rst actually contain DVB referencesMauro Carvalho Chehab3-28/+32
This document doesn't describe the DVB subsystem. Instead, it just contain references to some places. Better name it and improve its contents. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: dvb_intro.rst: update its contentsMauro Carvalho Chehab1-158/+572
The content there is somewhat outdated. Update to reflect the current status. While here, remove extra spaces, as we won't be preserving left margin alinment on this document. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: split avermedia.rst contents on two filesMauro Carvalho Chehab3-179/+204
Part of this document has nothing to do with the Avermedia driver. It is generic to the entire subsystem. So, split it on a separate file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-15media: docs: update cardlistsMauro Carvalho Chehab3-1/+13
There were some changes at the drivers adding support for more cards. Update cardlists accordingly. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-14media: ipu3.rst: add yuv-downscaling into pipeline diagramBingbu Cao1-8/+8
For ipu3 ImgU image processing, the frame data from TNR can feed into DDR by Output Formatting System or feed into YUV downscaler to do YUV downscaling for secondary output, which is usually used for display. current ImgU image pipeline diagram misses the YUV downscaling, this patch add it to aligh with actual hardware blocks. Signed-off-by: Bingbu Cao <bingbu.cao@intel.com> Suggested-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-14media: doc-rst: add yavta test example in ipu3 docsBingbu Cao1-0/+13
This patch add yavta test command in ipu3.rst as an example on how to run simple ImgU test using yavta. Signed-off-by: Bingbu Cao <bingbu.cao@intel.com> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-14media: imx.rst: Add example media graphsSteve Longerbeam3-7/+143
Add the media graph topologies for the i.MX6Q SabreSD and SabreAuto. This makes it easier to understand the topology and follow the entity descriptions in the following sections. Also clarify that the SabreSD and SabreLite media pipeline config examples are for the i.MX6Q boards. Signed-off-by: Steve Longerbeam <slongerbeam@gmail.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Hans Verkuil <hverkuil-cisco@xs4all.nl> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>