Commit Graph

45 Commits

Author SHA1 Message Date
Mauro Carvalho Chehab
a79a0e71ae media: admin-guide: reorganize the guide
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-22 08:29:23 +02:00
Mauro Carvalho Chehab
f45ce7a1e5 media: admin-guide: bt8xx.rst: fix a broken cross-reference
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-22 08:29:01 +02:00
Mauro Carvalho Chehab
8cf8f0a68a media: admin-guide: add test-drivers
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-22 08:28:46 +02:00
Mauro Carvalho Chehab
c84315dd8a media: admin-guide: add card lists for radio and firewire
Document the supported radio devices, plus document the
firewire driver.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:28:31 +02:00
Mauro Carvalho Chehab
a70559d37a media: admin-guide: add SPI cards to platform drivers
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-22 08:28:15 +02:00
Mauro Carvalho Chehab
c127fa9d3d media: admin-guide: add a list of I2C drivers
For completeness, let's add a list of I2C drivers.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:28:00 +02:00
Mauro Carvalho Chehab
9436af9eb4 media: admin-guide: add a list of platform drivers
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-22 08:27:42 +02:00
Mauro Carvalho Chehab
0753351432 media: admin-guide: add a table with USB drivers
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-22 08:27:24 +02:00
Mauro Carvalho Chehab
0cb8f667ec media: admin-guide: add a list of media PCI cards
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-22 08:27:05 +02:00
Mauro Carvalho Chehab
97b202b004 media: admin-guide: replace the frontend drivers list
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-22 08:26:38 +02:00
Mauro Carvalho Chehab
d3cb083207 media: admin-guide: split DVB cards.rst
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-22 08:26:12 +02:00
Mauro Carvalho Chehab
ea90626fdf media: admin-guide: add a cardlist for all other USB cards
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-22 08:25:39 +02:00
Mauro Carvalho Chehab
da95d30bb0 media: admin-guide: add a card list for the Siano driver
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-22 08:25:14 +02:00
Mauro Carvalho Chehab
4b45a0cd39 media: admin-guide: add support for the remaining dvb-usb boards
Add documentation for the remaining dvb-usb boards.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:24:38 +02:00
Mauro Carvalho Chehab
f21067392b media: admin-guide: add dibusb-mb and dibusb-mc card lists
Document the supported dib0300 boards.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:24:04 +02:00
Mauro Carvalho Chehab
9f054a7e7d media: admin-guide: add cardlist for dib0700 driver
Document the cards supported by dib0700 driver.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 08:23:01 +02:00
Mauro Carvalho Chehab
760ec48b6b media: admin-guide: add dvb-usb-v2 card lists
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-22 08:22:37 +02:00
Mauro Carvalho Chehab
17ce5e6d72 media: admin-guide: improve cardlist.rst documentation
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-22 08:19:01 +02:00
Mauro Carvalho Chehab
2aca74c8b1 media: admin-guide: add a generic building guide
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-22 07:48:36 +02:00
Mauro Carvalho Chehab
d9d43617bb media: admin-guide: Add an introduction chapter
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-22 07:47:53 +02:00
Mauro Carvalho Chehab
433c8e5660 media: admin-guide: update em28xx cardlist
A new em28xx card was added upstream. Update cards list
accordingly.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-22 07:45:44 +02:00
Mauro Carvalho Chehab
74da0d515c media: admin-guide: add a card list for cx231xx boards
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-22 07:45:28 +02:00
Fabio Estevam
d00c9761af media: imx.rst: Provide streaming examples for imx6q-sabresd
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-21 13:30:32 +02:00
Fabio Estevam
8a4676d6e6 media: imx.rst: Provide the OV560 module part number
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-21 13:29:34 +02:00
Fabio Estevam
62ce7201f4 media: imx.rst: Provide an example for unprocessed video capture
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-21 13:29:11 +02:00
Fabio Estevam
9429e7072f media: imx.rst: Fix the MIPI CSI-2 virtual channel
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-21 13:28:43 +02:00
Mauro Carvalho Chehab
63735af86d media: docs: add cros-references to the other media guides
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-15 15:51:24 +02:00
Mauro Carvalho Chehab
cc5d250e5a media: docs: move copyrights to the end and update them
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-15 15:51:24 +02:00
Mauro Carvalho Chehab
1c9eeba232 media: docs: get rid of obsoleted udev documentation
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
08256f12ac media: docs: zr364xx: update documentation
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
12bcf90c69 media: docs: saa7134.rst: update the documentation
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
8a1bfbc70d media: docs: update Digital TV faq.rst
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
fe877259d8 media: docs: cpia2.rst: do some cleanups
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
9fafef5857 media: docs: add a cardlist for cx18 boards
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
729126e4b4 media: docs: update bttv.rst information
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
f631516f6d media: docs: bt8xx.rst: update document info
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
c5b352431f media: docs: update avermedia.rst contents
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
03693a5a23 media: docs: intro.rst actually contain DVB references
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
109895a152 media: docs: dvb_intro.rst: update its contents
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
c4b89166d2 media: docs: split avermedia.rst contents on two files
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-15 15:51:23 +02:00
Mauro Carvalho Chehab
b533cad6fd media: docs: update cardlists
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-15 15:51:22 +02:00
Bingbu Cao
9611ba28d8 media: ipu3.rst: add yuv-downscaling into pipeline diagram
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-14 12:31:55 +02:00
Bingbu Cao
ce7d96a4a7 media: doc-rst: add yavta test example in ipu3 docs
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-14 12:20:37 +02:00
Steve Longerbeam
cdb82f826e media: imx.rst: Add example media graphs
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>
2020-04-14 11:35:49 +02:00
Mauro Carvalho Chehab
32e2eae23f media: docs: move user-facing docs to the admin guide
Most of the driver-specific documentation is meant to help
users of the media subsystem.

Move them to the admin-guide.

It should be noticed, however, that several of those files
are outdated and will require further work in order to make
them useful again.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-04-14 10:34:58 +02:00