summaryrefslogtreecommitdiff
path: root/Documentation/media
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-01 15:53:11 +0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-05 13:13:16 +0300
commitbbed074e8c58d9bf8fd7a57b1d796e1c43b43e75 (patch)
tree80040393ba179cc9ab7f93eb549b0e785a98aeba /Documentation/media
parent33047274346a830e9620764f11e37f5f6acc380d (diff)
downloadlinux-bbed074e8c58d9bf8fd7a57b1d796e1c43b43e75.tar.xz
media: dvb rst: identify the documentation gap at the API
Now that DVB spec is almost in sync, document what's missing. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media')
-rw-r--r--Documentation/media/uapi/dvb/ca.rst5
-rw-r--r--Documentation/media/uapi/dvb/legacy_dvb_apis.rst5
2 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/media/uapi/dvb/ca.rst b/Documentation/media/uapi/dvb/ca.rst
index 14b14abda1ae..e3de778a5678 100644
--- a/Documentation/media/uapi/dvb/ca.rst
+++ b/Documentation/media/uapi/dvb/ca.rst
@@ -10,6 +10,11 @@ accessed through ``/dev/dvb/adapter?/ca?``. Data types and and ioctl
definitions can be accessed by including ``linux/dvb/ca.h`` in your
application.
+.. note::
+
+ There are three ioctls at this API that aren't documented:
+ :ref:`CA_GET_MSG`, :ref:`CA_SEND_MSG` and :ref:`CA_SET_DESCR`.
+ Documentation for them are welcome.
.. toctree::
:maxdepth: 1
diff --git a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst b/Documentation/media/uapi/dvb/legacy_dvb_apis.rst
index 2957f5a988b0..dac349a1bb27 100644
--- a/Documentation/media/uapi/dvb/legacy_dvb_apis.rst
+++ b/Documentation/media/uapi/dvb/legacy_dvb_apis.rst
@@ -12,6 +12,11 @@ drivers should use it. Instead, audio and video should be using the V4L2
and ALSA APIs, and the pipelines should be set using the Media
Controller API
+.. note::
+
+ The APIs described here doesn't necessarily reflect the current
+ code implementation.
+
.. toctree::
:maxdepth: 1