Mauro Carvalho Chehab [Sat, 23 Jul 2016 10:12:03 +0000 (07:12 -0300)]
[media] doc-rst: add some needed escape codes
Some extra escape codes are needed to avoid Sphinx to not
identify the tags.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sat, 23 Jul 2016 10:21:06 +0000 (07:21 -0300)]
[media] doc-rst: kapi: use :c:func: instead of :cpp:func
References at the rst files for C functions generated via
kernel-doc should use :c:func:.
Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sat, 23 Jul 2016 10:13:59 +0000 (07:13 -0300)]
doc-rst: kernel-doc: fix a change introduced by mistake
changeset
b7e67f6c1bf7 ("doc-rst: linux_tv: supress lots of warnings")
were meant to touch only on media files, but it also touched
at this script by mistake. Revert such change.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 19:22:41 +0000 (16:22 -0300)]
[media] v4l2-ioctl.h add debug info for struct v4l2_ioctl_ops
This struct is mentioned at the kAPI docbook. So, let's document
it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 16:58:09 +0000 (13:58 -0300)]
[media] dvb_ringbuffer.h: some documentation improvements
Better document a note on this header.
While here, better format dvb_ringbuffer_pkt_read_user()
to adjust it to CodingStyle.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 16:57:29 +0000 (13:57 -0300)]
[media] v4l2-ctrls.h: fully document the header file
There are lots of undocumented stuff on this header.
Document them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 13:58:03 +0000 (10:58 -0300)]
[media] doc-rst: Fix some typedef ugly warnings
Sphinx can't handle well typedefs. Change two typedef
occurrences, in order to cleanup some of such warnings.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 13:15:42 +0000 (10:15 -0300)]
[media] doc-rst: reorganize the kAPI v4l2 chapters
Reorganize the order of the document, putting the chapters
on a more logical order and renaming some sections.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 12:43:28 +0000 (09:43 -0300)]
[media] rename v4l2-framework.rst to v4l2-intro.rst
Now that the only remaining chapters at v4l2-framework are
the introduction ones, let' s rename the file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 12:38:58 +0000 (09:38 -0300)]
[media] move V4L2 clocks to a separate .rst file
Move the v4l2 clocks stuff from v4l2-framework to a separate
file and adds an attention that came from the v4l2-clk.h.
Note: as this is meant to be a temporary kAPI, and it is
used only by two drivers (soc_camera and em28xx), where
the first one is in deprecation process, it probably not
a worth effort to document its header.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 12:31:16 +0000 (09:31 -0300)]
[media] v4l2-fh.rst: add cross references and markups
Add cross-references with the kernel-doc functions/structs
and improve the markups.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 12:10:20 +0000 (09:10 -0300)]
[media] v4l2-fh.rst: add fh contents from v4l2-framework.rst
Move the v4l2_fh specific content from v4l2-framework.rst
to v4l2-fh.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 12:06:45 +0000 (09:06 -0300)]
[media] v4l2-fh.h: add documentation for it
This header file was undocumented. Add documentation for it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 11:43:30 +0000 (08:43 -0300)]
[media] v4l2-event.rst: add cross-references and markups
Improve events documentation by adding cross references,
sub-titles and other markup elements.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 10:27:06 +0000 (07:27 -0300)]
[media] v4l2-event.h: document all functions
Several functions weren't documented. Document them all.
While here, makes checkpatch.pl happy.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 09:54:48 +0000 (06:54 -0300)]
[media] v4l2-event.rst: add text from v4l2-framework.rst
Move the v4l2 event-specific text from v4l2-framework.rst
to v4l2-event.rst. That helps to keep the text together with
the functions it describes, and makes easier to identify
documentation gaps.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Fri, 22 Jul 2016 09:50:01 +0000 (06:50 -0300)]
[media] v4l2-framework.rst: remove videobuf quick chapter
As we merged the videobuf chapter at the kABI section, and it
is a way more complete, just remove the small videobuf chapter
that came from framework.txt.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 20:05:35 +0000 (17:05 -0300)]
[media] v4l2-dev: add cross-references and improve markup
Add cross-references for the functions/structs and add
the markup tags to improve its display.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 18:37:34 +0000 (15:37 -0300)]
[media] doc-rst: move v4l2-dev doc to a separate file
Move the documentation for video device node creation to
a separate file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 18:30:20 +0000 (15:30 -0300)]
[media] doc-rst: document v4l2-dev.h
Add documentation for v4l2-dev.h, and put it at v4l2-framework.rst,
where struct video_device is currently documented.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 18:29:11 +0000 (15:29 -0300)]
[media] mc-core: Fix a cross-reference
The v4l2_subdev reference was using the wrong tag. Fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 15:26:04 +0000 (12:26 -0300)]
[media] v4l2-common.h: Add documentation for other functions
Not all functions at v4l2-common.h are documented. Add
documentation for some other ones.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 13:08:31 +0000 (10:08 -0300)]
[media] v4l2-common.h: document the subdev functions
There are some subdev-specific functions at v4l2-common.h
that are mentioned at v4l2-subdev.rst.
Document them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 12:49:32 +0000 (09:49 -0300)]
[media] v4l2-subdev.rst: add cross references to new sections
The two new sections were missing cross-references, and had
some other minor issues with the markups. Add such things.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 12:27:37 +0000 (09:27 -0300)]
[media] v4l2-subdev.rst: add two sections from v4l2-framework.rst
There are two additional subdev-specific sections at the
v4l2-framework file. Move them to the subdev chapter, in order
to better organize the book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 12:24:55 +0000 (09:24 -0300)]
[media] v4l2-async: document the remaining stuff
There are one enum and 4 functions undocumented there.
Document them. That will fix the broken links at the
v4l2-subdev.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 12:13:11 +0000 (09:13 -0300)]
[media] doc-rst: merge v4l2-async.rst with v4l2-subdev.rst
The Async API is actually part of the v4l2 subdev.
Move its declarations to it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Thu, 21 Jul 2016 12:09:58 +0000 (09:09 -0300)]
[media] v4l2-subdev.rst: add cross-references
Enrich the subdevice description by linking it to the
functions and structs from v4l2-subdev.h.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 17:20:26 +0000 (14:20 -0300)]
[media] v4l2-subdev.h: Improve documentation
This header were poorly documented, and weren't using the
kernel-doc format. Document everything but the macros using
the right format.
While here, also fix the other comments to match the
Linux CodingStyle.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 18:27:04 +0000 (15:27 -0300)]
[media] v4l2-subdev.rst: add documentation from v4l2-framework.rst
There are lots of documentation about V4L2 subdevices at
v4l2-framework.rst. Move them to its specific chapter at
v4l2-subdev.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 18:20:02 +0000 (15:20 -0300)]
[media] v4l2-device.rst: do cross references with kernel-doc
This document describes the main kAPI interfaces for the
v4l2-device.h header. Add cross references to the documentation
produced via kernel-doc.
While here, also use monotonic font for constants.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 18:07:56 +0000 (15:07 -0300)]
[media] v4l2-device.rst: add contents from v4l2-framework
Part of the contents of v4l2-framework is related to the
kAPI defined by v4l2-device. Move such contents to the
v4l2-device.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 17:14:37 +0000 (14:14 -0300)]
[media] doc-rst: Split v4l-core into one file per kAPI
Sphinx produce a 1:1 mapping between a rst file and an html file.
So, we need to split the kernel-doc tags on multiple documents.
A side effect is that we're now having a better name for each
section of the kAPI documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 16:05:05 +0000 (13:05 -0300)]
[media] v4l2-device.h: document functions
The functions at v4l2-device.h are not using the proper
markups. Add it, and include at the v4l2-core.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 14:27:17 +0000 (11:27 -0300)]
[media] doc-rst: Fix license for the media books
The kAPI, v4l-drivers and dvb-drivers never used the
GNU FDL license. The addition of such license header were
just due to copy-and-paste. So, let's fix it.
As the media_kapi were part of device-drivers.tmp, it is
under GPL v2+.
The other two books is an agregation of files without any
license explicitly specified. So, they're all bound to the
Kernel's COPYING license. So, they're GPL v2 only.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 14:15:31 +0000 (11:15 -0300)]
[media] media-entry.h: Fix a note markup
The Sphinx note markup for media_remove_intf_links() is wrong:
there's a missing space.
While here, let's auto-numerate the two notes.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 13:36:18 +0000 (10:36 -0300)]
[media] doc-rst: better organize the media books
The uAPI book has 5 parts, but they lost numeration after
conversion to rst. Manually number those parts, and make
the main index with 1 depth, to only show the parts and
the annexes.
At each part, use :maxwidth: 5, in order to show a more
complete index.
While here, fix the cross-references between different
books.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Wed, 20 Jul 2016 12:22:38 +0000 (09:22 -0300)]
[media] doc-rst: Fix some Sphinx warnings
Fix all remaining media warnings with ReST that are fixable
without changing at the Sphinx code.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sat, 23 Jul 2016 10:59:19 +0000 (07:59 -0300)]
Merge branch 'patchwork' into topic/docs-next
* patchwork: (1492 commits)
[media] cec: always check all_device_types and features
[media] cec: poll should check if there is room in the tx queue
[media] vivid: support monitor all mode
[media] cec: fix test for unconfigured adapter in main message loop
[media] cec: limit the size of the transmit queue
[media] cec: zero unused msg part after msg->len
[media] cec: don't set fh to NULL in CEC_TRANSMIT
[media] cec: clear all status fields before transmit and always fill in sequence
[media] cec: CEC_RECEIVE overwrote the timeout field
[media] cxd2841er: Reading SNR for DVB-C added
[media] cxd2841er: Reading BER and UCB for DVB-C added
[media] cxd2841er: fix switch-case for DVB-C
[media] cxd2841er: fix signal strength scale for ISDB-T
[media] cxd2841er: adjust the dB scale for DVB-C
[media] cxd2841er: provide signal strength for DVB-C
[media] cxd2841er: fix BER report via DVBv5 stats API
[media] mb86a20s: apply mask to val after checking for read failure
[media] airspy: fix error logic during device register
[media] s5p-cec/TODO: add TODO item
[media] cec/TODO: drop comment about sphinx documentation
...
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sat, 23 Jul 2016 10:55:59 +0000 (07:55 -0300)]
Merge branch 'docs-next' of git://git.lwn.net/linux into topic/docs-next
* 'docs-next' of git://git.lwn.net/linux:
doc-rst: kernel-doc: fix handling of address_space tags
Revert "doc/sphinx: Enable keep_warnings"
doc-rst: kernel-doc directive, fix state machine reporter
docs: deprecate kernel-doc-nano-HOWTO.txt
doc/sphinx: Enable keep_warnings
Documentation: add watermark_scale_factor to the list of vm systcl file
kernel-doc: Fix up warning output
docs: Get rid of some kernel-documentation warnings
Mauro Carvalho Chehab [Fri, 22 Jul 2016 14:46:36 +0000 (11:46 -0300)]
doc-rst: kernel-doc: fix handling of address_space tags
The RST cpp:function handler is very pedantic: it doesn't allow any
macros like __user on it:
Documentation/media/kapi/dtv-core.rst:28: WARNING: Error when parsing function declaration.
If the function has no return type:
Error in declarator or parameters and qualifiers
Invalid definition: Expecting "(" in parameters_and_qualifiers. [error at 8]
ssize_t dvb_ringbuffer_pkt_read_user (struct dvb_ringbuffer * rbuf, size_t idx, int offset, u8 __user * buf, size_t len)
--------^
If the function has a return type:
Error in declarator or parameters and qualifiers
If pointer to member declarator:
Invalid definition: Expected '::' in pointer to member (function). [error at 37]
ssize_t dvb_ringbuffer_pkt_read_user (struct dvb_ringbuffer * rbuf, size_t idx, int offset, u8 __user * buf, size_t len)
-------------------------------------^
If declarator-id:
Invalid definition: Expecting "," or ")" in parameters_and_qualifiers, got "*". [error at 102]
ssize_t dvb_ringbuffer_pkt_read_user (struct dvb_ringbuffer * rbuf, size_t idx, int offset, u8 __user * buf, size_t len)
------------------------------------------------------------------------------------------------------^
So, we have to remove it from the function prototype.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Corbet [Wed, 20 Jul 2016 22:56:21 +0000 (16:56 -0600)]
Revert "doc/sphinx: Enable keep_warnings"
This reverts commit
47d6d752b9e20dbe8a2acd22e887be81a6f39de9.
Commit
f42ddca7bebc (doc-rst: kernel-doc directive, fix state machine
reporter) from Marcus Heiser provides a better fix, so this configuration
change is no longer needed.
Markus Heiser [Wed, 20 Jul 2016 10:38:58 +0000 (12:38 +0200)]
doc-rst: kernel-doc directive, fix state machine reporter
Add a reporter replacement that assigns the correct source name and line
number to a system message, as recorded in a ViewList.
[1] http://mid.gmane.org/CAKMK7uFMQ2wOp99t-8v06Om78mi9OvRZWuQsFJD55QA20BB3iw@mail.gmail.com
Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Tested-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Jonathan Corbet [Wed, 20 Jul 2016 22:43:41 +0000 (16:43 -0600)]
docs: deprecate kernel-doc-nano-HOWTO.txt
Now that the new Sphinx world order is taking over, the information in
kernel-doc-nano-HOWTO.txt is outmoded. I hate to remove it altogether,
since it's one of those files that people expect to find. But we can add a
warning and fix all the other pointers to it.
Reminded-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Daniel Vetter [Tue, 19 Jul 2016 11:42:54 +0000 (13:42 +0200)]
doc/sphinx: Enable keep_warnings
Unfortunately warnings generated after parsing in sphinx can end up
with entirely bogus files and line numbers as sources. Strangely for
outright errors this is not a problem. Trying to convert warnings to
errors also doesn't fix it.
The only way to get useful output out of sphinx to be able to root
cause the error seems to be enabling keep_warnings, which inserts
a System Message into the actual output. Not pretty at all, but I
don't really want to fix up core rst/sphinx code, and this gets the job
done meanwhile.
Cc: Markus Heiser <markus.heiser@darmarit.de>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Hans Verkuil [Tue, 19 Jul 2016 09:26:13 +0000 (06:26 -0300)]
[media] doc-rst: cec: update documentation
Update and expand the CEC documentation. Especially w.r.t. non-blocking
mode.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Mon, 18 Jul 2016 06:44:10 +0000 (03:44 -0300)]
[media] cec: always check all_device_types and features
Even when the adapter is configured for CEC 1.4, we still check and
use the CEC 2.0 parts of struct cec_log_addrs. Although these aren't
used in CEC messages, the information contained in them is still of
use in the CEC framework itself, so keep this information.
Also zero the unused trailing features[] data and unused logical address
data so the contents isn't random data.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sun, 17 Jul 2016 16:02:44 +0000 (13:02 -0300)]
[media] cec: poll should check if there is room in the tx queue
For POLLOUT poll only checked if the adapter was configured, not
if there was room in the transmit queue. Add that check.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sat, 16 Jul 2016 13:49:36 +0000 (10:49 -0300)]
[media] vivid: support monitor all mode
Just pass the transmitted CEC message to all CEC adapters.
This implements the Monitor All mode for vivid.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sun, 17 Jul 2016 14:42:06 +0000 (11:42 -0300)]
[media] cec: fix test for unconfigured adapter in main message loop
The main message loop checks if the physical address was valid, and if
not it is assumed that the adapter had been unconfigured.
However, this check is no longer correct, instead it should check
that both adap->is_configured and adap->is_configuring are false.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sun, 17 Jul 2016 14:40:05 +0000 (11:40 -0300)]
[media] cec: limit the size of the transmit queue
The size of the transmit queue was unlimited, which meant that
in non-blocking mode you could flood the CEC adapter with messages
to be transmitted.
Limit this to 18 messages.
Also print the number of pending transmits and the timeout value
in the status debugfs file.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sun, 17 Jul 2016 08:16:40 +0000 (05:16 -0300)]
[media] cec: zero unused msg part after msg->len
Ensure that the unused part of the msg array is zeroed. This is
required by CEC 2.0 when receiving shorter messages than expected.
In that case the remaining bytes are assumed to be 0.
There are no such CEC messages yet, but it is required to be future proof.
And since we're doing it for received messages, do it for transmitted
messages as well. It's unambiguous this way.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sat, 16 Jul 2016 12:59:18 +0000 (09:59 -0300)]
[media] cec: don't set fh to NULL in CEC_TRANSMIT
The filehandle was set to NULL when in non-blocking mode or when
no reply is needed.
This is wrong: the filehandle is needed in non-blocking mode to ensure
that the result of the transmit can be obtained through CEC_RECEIVE.
And the 'reply' check was also incorrect since it should have checked the
timeout field (the reply can be 0). In any case, when in blocking mode
there is no need to set the fh to NULL either.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sat, 16 Jul 2016 12:44:13 +0000 (09:44 -0300)]
[media] cec: clear all status fields before transmit and always fill in sequence
Before transmitting a message clear all status fields and always fill
in the sequence number. Make sure the sequence number is never 0.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Hans Verkuil [Sat, 16 Jul 2016 10:58:31 +0000 (07:58 -0300)]
[media] cec: CEC_RECEIVE overwrote the timeout field
When CEC_RECEIVE returns a message the original timeout field
was overwritten. Restore the timeout field.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Tue, 19 Jul 2016 15:35:08 +0000 (12:35 -0300)]
[media] doc-rst: backward compatibility with older Sphinx versions
Sphinx is really evil when an older version finds an extra
attribute for the :toctree: tag: it simply ignores everything
and produce documents without any chapter inside!
As we're now using tags available only on Sphinx 1.4.x, we
need to use some creative ways to add a title before the
table of contents. Do that by using a css class.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 18:01:20 +0000 (15:01 -0300)]
[media] doc-rst: better name the media books
The titles at the media books were misleading, and some books
were not numbered.
Rename the kAPI book to better reflect its contents, be more
consistent on the initial rst file for each book and better
name them.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 17:46:07 +0000 (14:46 -0300)]
[media] doc-rst: fix media kAPI documentation
I ended by adding twice each media header, because I saw some
missing stuff at the documents. It seems it was my mistake,
as everything seems to be there.
So, remove those extra stuff, to avoid duplicating the
documentation of the functions.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 17:28:58 +0000 (14:28 -0300)]
[media] get rid of Documentation/video4linux/lifeview.txt
Move the contents of this file to bttv.rst and saa7134.rst.
With that, we can finally remove Documentation/video4linux.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 17:18:10 +0000 (14:18 -0300)]
[media] cx88.rst: add contents of hauppauge-wintv-cx88-ir.txt
Import the contents of hauppauge-wintv-cx88-ir.txt, after
converted to ReST into cx88.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 17:10:40 +0000 (14:10 -0300)]
[media] cx88.rst: add contents from not-in-cx2388x-datasheet.txt
There are some information about missing/wrong documentation at
cx231xx datasheet. Add it to the cx88 chapter.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 17:07:10 +0000 (14:07 -0300)]
[media] cx2341x.rst: add contents of README.vbi
Finally, adds the content of README.vbi at cx2341x.rst after
its conversion to ReST format.
Now, add information about this chipset and its driver is
inside a single chapter at the media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 17:01:51 +0000 (14:01 -0300)]
[media] cx2341x: add contents of README.hm12
The README.hm12 file describes the proprietary format used
by this driver for raw format, called HM12. Add its description
at the document, after converted to ReST.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 16:56:43 +0000 (13:56 -0300)]
[media] cx2341x.rst: add contents of fw-osd-api.txt
Convert it to ReST format and add to cx2341x.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 16:45:27 +0000 (13:45 -0300)]
[media] cx2341x.rst: add the contents of fw-upload.txt
Add the contents of fw-upload.txt, after converting it to
ReST format.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 16:42:17 +0000 (13:42 -0300)]
[media] cx2341x.rst: add contents of fw-memory.txt
Convert the content to ReST and add it at the cx231xx.rst
file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 16:32:53 +0000 (13:32 -0300)]
[media] cx2341x.rst: add contents of fw-dma.txt
Add the contents of fw-dma.txt, converted to ReST, and
drop the old file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 16:26:30 +0000 (13:26 -0300)]
[media] cx2341x.rst: add the contents of fw-calling.txt
Convert it to ReST and add its contents at this file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 15:48:36 +0000 (12:48 -0300)]
[media] cx2341x.rst: Add the contents of fw-encoder-api.txt
Convert its contents to ReST and add to cx2341x.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 14:08:24 +0000 (11:08 -0300)]
[media] cx2341x.rst: add fw-decoder-registers.txt content
Convert the contents of fw-decoder-registers.txt to ReST and
add it to cx2341x.rst file.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Jerome Marchand [Tue, 12 Jul 2016 10:05:59 +0000 (12:05 +0200)]
Documentation: add watermark_scale_factor to the list of vm systcl file
Commit
795ae7a0de6b ("mm: scale kswapd watermarks in proportion to
memory") properly added the description of the new knob to
Documentation/sysctl/vm.txt, but forgot to add it to the list of files
in /proc/sys/vm. Let's fix that.
Signed-off-by: Jerome Marchand <jmarchan@redhat.com>
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 14:03:54 +0000 (11:03 -0300)]
[media] doc-rst: start adding documentation for cx2341x
move the contents of fw-decoder-api.txt to cx2341x and
convert it to ReST file, adding it to media/v4l-drivers
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 13:38:35 +0000 (10:38 -0300)]
[media] doc-rst: add documentation for tuners
Convert bttv/Tuners to ReST and add it to the media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 13:30:59 +0000 (10:30 -0300)]
[media] doc-rst: add documentation for bttv driver
Convert it to ReST and add it to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 13:04:48 +0000 (10:04 -0300)]
[media] doc-rst: move bttv documentation to bttv.rst file
There were several files under Documentation/video4linux/bttv.
Instead of simply copying them to the rst folder, I opted to
merge into a single document and adjust the headers to
adjust the section levels and fix the cards tables.
There are two exceptions on the merge:
- The Tuners were renamed as a separate document, as they
describe a separate driver;
- I removed the PROBLEMS section. It describes problems with
the very first generation of 3D boards (Mistique/S3).
It sounds very unlikely that someone would still need to
install a bttv board on such hardware. Also, it is not
very well written, IMHO.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Daniel Vetter [Fri, 15 Jul 2016 08:19:30 +0000 (10:19 +0200)]
kernel-doc: Fix up warning output
While trying to make gpu docs warning free I stumbled over one output
which wasn't following proper compiler error output standards. Fix it
up for more quickfix awesomeness.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 01:34:51 +0000 (22:34 -0300)]
[media] v4l-with-ir.rst: update it to reflect the current status
This document were really old. Update it to reflect the current
status of the IR drivers for TV.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 01:11:47 +0000 (22:11 -0300)]
[media] doc-rst: add documentation about IR on V4L boards
This section is outdated, but let's add it, after converting
to ReST, and then fix it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 01:07:30 +0000 (22:07 -0300)]
[media] doc-rst: add vivid documentation
Convert it to ReST and add to media/v4l-drivers book.
As the sections here (and on other docs) are numbered,
let's also make this book auto-numbered.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Mon, 18 Jul 2016 00:29:09 +0000 (21:29 -0300)]
[media] doc-rst: add documentation for Zoran driver
Convert it to ReST and add to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 23:50:45 +0000 (20:50 -0300)]
[media] doc-rst: add documentation for uvcvideo
Convert it to ReST and add to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 23:44:13 +0000 (20:44 -0300)]
[media] doc-rst: add soc-camera documentation
Convert it to ReST format and add it at media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 23:32:28 +0000 (20:32 -0300)]
[media] doc-rst: add documentation for si476x
Convert it to ReST and add to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 23:07:16 +0000 (20:07 -0300)]
[media] doc-rst: add documentation for si4713
Convert it to ReST and add it to the media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 22:52:48 +0000 (19:52 -0300)]
[media] doc-rst: add documentation for si470x
Convert it to ReST and add to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 22:43:22 +0000 (19:43 -0300)]
[media] doc-rst: add sh_mobile_ceu_camera crop documentation
Convert it to ReST and add it to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 22:26:43 +0000 (19:26 -0300)]
[media] doc-rst: add documentation for saa7134
Convert it to ReST and add to the media/v4l-device book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 22:03:53 +0000 (19:03 -0300)]
[media] doc-rst: add documentation for radiotrack
Convert it to ReST and add it to the media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 21:52:53 +0000 (18:52 -0300)]
[media] doc-rst: add pxa_camera documentation
Convert pxa_camera to ReST format and add it to the
media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 21:45:25 +0000 (18:45 -0300)]
[media] doc-rst: add documentation for pvrusb2
Convert pvrusb2 documentation to ReST file and removed the note
about an html version of the documentation, as it is not
shipped inside the Kernel.
Add it to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 21:38:01 +0000 (18:38 -0300)]
[media] doc-rst: add omap4_camera documentation
Convert the omap4_camera documentation to ReST and add it to
the media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 21:31:51 +0000 (18:31 -0300)]
[media] doc-rst: add omap3isp documentation
Convert omap3isp documentation to ReST and add it to the
media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 21:20:51 +0000 (18:20 -0300)]
[media] doc-rst: add meye documentation
Convert the meye documentation to rst and add it to the
media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 21:13:46 +0000 (18:13 -0300)]
[media] doc-rst: Add ivtv documentation
Convert ivtv documentation to rst, update the links there
and add to media/v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 20:57:31 +0000 (17:57 -0300)]
[media] doc-rst: add documentation for fimc driver
Convert the document to rst and add it to the v4l-drivers
book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 20:49:05 +0000 (17:49 -0300)]
[media] doc-rst: add davinci-vpbe documentation
Convert it to rst format and add it to the v4l-drivers book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 20:44:45 +0000 (17:44 -0300)]
[media] cx88.rst: Update the documentation
This doc is outdated, and contains information that it is not
true anymore. Update it to reflect the changes that this
driver suffered since I started working on it.
While here, also update Gerd's name.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 20:28:40 +0000 (17:28 -0300)]
[media] doc-rst: Add cx88 documentation to media book
Convert the cx88 documentation to rst and add it to the v4l-devices
book
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 20:20:26 +0000 (17:20 -0300)]
[media] doc-rst: add documentation for cpia2 driver
Convert the documentation to rst, merge the two files and
add to the index.rst.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Mauro Carvalho Chehab [Sun, 17 Jul 2016 20:05:20 +0000 (17:05 -0300)]
[media] doc-rst: add Zoran zr364xx documentation
Convert the documentation to rst and add it to the book.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>